Skip to main content

Get Many Orders​

Get Many Orders

Query Parameters
  • startCreatedAt date

    Creation start date in the filter

    Example: 2022-04-20
  • endCreatedAt date

    Creation end date in the filter

    Example: 2022-04-20
  • startDeliveryDate date

    Delivery start date in the filter

    Example: 2022-04-20
  • endDeliveryDate date

    Delivery end date in the filter

    Example: 2022-04-20
  • startLastNonPaymentDate date

    Orders which have a last non payment date greater than or equal to this date

    Example: 2022-04-20
  • endLastNonPaymentDate date

    Orders which have a last non payment date less than or equal to this date

    Example: 2022-04-20
  • paymentStatus string

    Possible values: [COD_PAID, NET_TERMS_PAID, PROCESSING, REMITTED, SELF_COLLECTED, UNPAID, PAYMENT_SENT, WRITE_OFF, THIRD_PARTY_COLLECTIONS, PARTIAL_PAID, DRIVER_PROCESSING]

    Payment Status

  • paymentTerms string

    Possible values: [0, 7, 14, 15, 30, 45, 60, 90]

    Payment Terms; 0 implies COD

  • action string

    Possible values: [DELIVERY_TO_BRAND, DELIVERY_TO_RETAILER, DROPOFF_TO_NABIS, INTERNAL_TRANSFER, PICKUP_FROM_BRAND, PICKUP_FROM_NABIS]

    Order Action

  • status string

    Possible values: [ATTEMPTED, CANCELLED, DELAYED, DELIVERED, DELIVERED_WITH_EDITS, IN_TRANSIT, REJECTED, SCHEDULED, TRANSFERRING, UNSCHEDULED]

    Order Status

  • referrer string

    Possible values: [BRAND, RETAILER]

    Order Referrer

  • warehouse uuid

    Order Warehouse

  • startUpdatedAt date

    Updated start date in the filter

    Example: 2022-04-20
  • endUpdatedAt date

    Updated end date in the filter

    Example: 2022-04-20
  • lastNonPaymentReason boolean

    Filter by orders with a lastNonPaymentReason

  • page number required
  • limit number required

    Possible values: >= 1 and <= 500

Responses

Successful Operation

Schema
  • id uuid

    System-generated UUID to identify order

  • deliveryDate date

    Date upon which order is delivered

  • createdDate date

    Date upon which order is submitted/created

  • createdTimestamp date-time

    Timestamp upon which order is submitted/created

  • updatedDate date

    Date upon which order is updated

  • updatedTimestamp date-time

    Timestamp upon which order is updated

  • order number

    System-generated numeric ID for order

  • lineItemId uuid

    Unique ID of each line-item on order

  • orderName string

    Brand-input name describing order

  • organization string

    Name of Brand organization

  • orderAction string

    Possible values: [DELIVERY_TO_BRAND, DELIVERY_TO_RETAILER, DROPOFF_TO_NABIS, INTERNAL_TRANSFER, PICKUP_FROM_BRAND, PICKUP_FROM_NABIS]

    Label of order that describes the type of movement that is occurring

  • status string

    Possible values: [ATTEMPTED, CANCELLED, DELAYED, DELIVERED, DELIVERED_WITH_EDITS, IN_TRANSIT, REJECTED, SCHEDULED, TRANSFERRING, UNSCHEDULED]

    Description of the delivery status of an order; "completed" orders have status of 'Delivered' or 'Delivered With Edits'

  • creator email

    Email address of user that submitted order

  • retailer string

    Name of order destination

  • retailerParentOrganization string

    Name of retailer parent organization

  • siteAddress string

    Address of order destination

  • manufacturerLicenseNumber string

    License number of the manufacturing entity associated with the inventory item

  • titleholderLicenseNumber string

    License number of the title-holding entity associated with the inventory item

  • siteLicenseNumber string

    License number of order destination

  • sourceWarehouse uuid

    Nabis warehouse of origination

  • orderSubtotal number

    $ Subtotal of the Gross Merchandise Value of order (equals sum of all line-item subtotal). Formerly known as orderGMV.

  • subtotalCollected number

    $ amount collected for order (typically from partial payments).

  • orderDiscount number

    $ Amount of order-level discount reducing overall order $ amount (related to the specific order/transaction)

  • creditMemo number

    $ Amount of order-level credit reducing overall order $ amount (not related to specific order/transaction; reflects pre-existing agreement)

  • surcharge number

    Surcharge

  • skuCode string

    Brand-input code for inventory item, typically used for internal brand system mapping

  • strain string

    Strain

  • units number

    Number of units per line-item on order

  • pricePerUnit number

    Line-Item price per unit $ value on order

  • standardPricePerUnit number

    The wholesale, un-discounted system unit price of a product from the Inventory Tab at time of order creation

  • lineItemDiscount number

    $ Amount of discount applied on a per line-item level

  • lineItemSubtotal number

    Subtotal gross $ amount for a line item (equals Number of Units x Price Per Unit). Formerly known as lineItemGMV.

  • lineItemUpdatedAt date-time

    Most recent date upon which line item details were adjusted

  • lineItemNotes string

    Notes entered in for the line item

  • batchNumber string

    Brand-input value for a batch to identify and trace items that share characteristics of production

  • batchExpiration date

    Date upon which a product's COA has lapsed; re-testing or destruction is required at this point

  • unitDescription string

    Description of the item's unit characteristics (i.e., 6-pack)

  • inventoryCategory string

    Possible values: [AIRGRAFT, BAKED_GOOD, BALM, BATTERY, BEVERAGE, BOTANICAL, BROWNIE, BUD, BUDDER, BUTANE_HASH_OIL, BUTTER, CANDY, CAPSULE, CARTRIDGE, CARTRIDGE_510, CHIPS, CHOCOLATE, CO2_OIL, COFFEE, COLD_WATER_HASH, CONCENTRATE, COOKIE, CREAM, CRUMBLE, CRYSTALLINE, DART, DIAMONDS, DISPOSABLE, DISSOLVABLE_POWDER, FROST, GREENHOUSE, GUMMY, HARD_CANDY, HASH, HONEY, ICE_CREAM, INDOOR, INFUSED_FLOWER, INFUSED_PRE_ROLLS, INHALER, JUICE, KIEF, KIF, LEAFLETTES, LIGHT_DEP, LIP_BALM, LIVE_RESIN, MARSHMALLOW, MINT, MIXED, OIL, OTHER, OTHER_BATTERY_TYPES, OUTDOOR, PACK, PATCH, PAX, PEN, PILL, POPCORN, POPS, PRE_GROUND, PRE_ROLLS, PROPRIETARY, READY_TO_ROLL, ROSIN, SALVE, SAUCE, SELTZER, SHAKE, SHATTER, SHOT, SINGLE, SODA, SOLVENTLESS, SPRAY, SUBLINGUAL, SUGAR, SUN_GROWN, SUPPOSITORY, TABLETS, TAFFY, TEA, THREAD_510, TINCTURES, TRANSDERMAL, TRIM, WATER, WAX, WHOLE_FLOWER]

    Specific categorization of an item's characteristics (i.e., gummy, chocolate, etc.)

  • inventoryClass string

    Possible values: [CONCENTRATE, EDIBLES, FLOWER, OTHER, PERSONAL_CARE, PRE_ROLL, VAPE]

    General classification of an item's characteristics (i.e., edible)

  • inventoryType string

    Possible values: [CANNABIS, NON_CANNABIS]

    If the item is cannabis or non-cannabis

  • sample boolean

    If the line-item is marked as a Sample on order

  • skuIsArchived boolean

    If the line-item is archived

  • exciseTax number

    $ Amount of the Excise Tax of order incurred from the sale of cannabis products

  • daysTillPaymentDue number

    Numeric value representing # of days in payment terms of order

  • posoNumber string

    Brand-input value reflecting internal brand system ID to identify corresponding Nabis order

  • paymentStatus string

    Possible values: [COD_PAID, NET_TERMS_PAID, PROCESSING, REMITTED, SELF_COLLECTED, UNPAID, PAYMENT_SENT, WRITE_OFF, THIRD_PARTY_COLLECTIONS, PARTIAL_PAID, DRIVER_PROCESSING]

    Description of the payment status of an order

  • remittedAt date-time

    Date upon which funds for order were remitted to brand

  • paidAt date-time

    Date upon which funds for order were paid in full

  • notes string

    Brand-input notes regarding delivery instructions / requirements

  • manifest uri

    URL for order PDF documentation

  • retailerId uuid

    System-generated unique ID of order destination

  • retailerParentOrganizationId uuid

    System-generated unique ID of order destination parent organization

  • pocName string

    Point Of Contact name details

  • pocPhoneNumber string

    Point Of Contact phone number

  • pocEmail email

    Point Of Contact email address

  • fromMarketplace string

    If order was submitted on Nabis Marketplace (created by a retail customer)

  • paymentTerms string

    Terms indicating the number of days past delivery date when payment is due

  • isSampleDemo boolean

    Is Sample Demo

  • skuBatchId uuid

    System-generated UUID for SkuBatch identifier

  • orderInventoryStatus string

    Possible values: [FULFILLED, ORDERED, PACKED]

    Order Inventory Status

  • brandName string

    Brand Name

  • soldBy email

    Email address of brand team member assigned to order

  • batchAromas string[]

    Aroma characteristics of batch

  • batchTags string[]

    Internal-facing batch tags, visible to brands and admins (not visible on marketplace)

  • batchThcAPercentage number

    % THC-A value of batch

  • batchThcPercentage number

    % THC value of batch

  • retailerCreditRating string

    Possible values: [EXCELLENT, GOOD, FAIR, WEAK, POOR, NOT_APPLICABLE]

    Retailer's credit rating at time of order placement

  • skuStrainType string

    Strain characteristics of inventory item

  • siteCity string

    City of delivery destination

  • siteZip string

    Zip Code of delivery destination

  • orderTotal number

    Order Total $ Amount of Merchandise Value after all trade spend. Formerly known as orderNetGMV.

  • lineItemSubtotalAfterDiscount number

    Line-Item net subtotal $ value after line-item discounts (equals Line Item Subtotal - Line Item Discount)

  • lineItemPricePerUnitAfterDiscount number

    Line-Item effective price per unit $ value after line-item discounts (equals line-item subtotalAfterDiscount / Units)

  • lineItemPriceDifference number

    Line-Item-level reductions from the wholesale value to the net line-item value

  • orderTsPerLine number

    Order-level reductions from order trade spend per line-item applied proportionally to line-item value

  • totalTsPerLine number

    Total reductions per line-item (sum of lineItemPriceDifference and orderTsPerLine)

  • wholesaleValue number

    Total order wholesale $ amount across all line items (equals Sum of all Line Item Wholesale Value)

  • priceReduction number

    Order-level delta between Wholesale Value and Order Subtotal (equals Wholesale Value - Order Subtotal)

  • lineItemWholesaleValue number

    The wholesale $ value for a line item (equals Number of Units x Standard Price Per Unit)

  • skuDisplayName string

    The SKU's Marketplace display name (optional).

  • skuName string

    The name of the SKU

  • skuCasePackSize number

    The number of eaches the SKU is sold by

  • skuTotalPrice number

    The total price of the SKU (skuPricePerUnit * skuCasePackSize)

  • skuPricePerUnit number

    The unit price of each unit in the case.

  • skuTags string[]

    Custom Classification Associated with an Item

  • mustPayPriorBalance boolean

    Must pay prior balance (Balances required for delivery will be associated with orders created after 2023-03-29)

  • nabisNotes string

    Nabis notes for manifest

  • lastNonPaymentDate date

    The last non-payment date for this order

  • lastNonPaymentReason string

    Possible values: [DISCREPANCY_IN_PRICING_OF_PRODUCTS_RECEIVED, DISCREPANCY_IN_QUALITY_OR_NATURE_OF_PRODUCTS_RECEIVED, INSOLVENCY_RISK, INSUFFICIENT_FUNDS, ORDER_NEVER_RECEIVED, PICKUP_UNALIGNED_WITH_RETAILER_ACCOUNTING_PRACTICES, REPRESENTATIVE_CANNOT_FACILITATE_PAYMENT, RETAILER_ALLEGES_TO_HAVE_ALREADY_PAID_INVOICE_TO_BRAND, RETAILER_ALLEGES_TO_HAVE_ALREADY_PAID_INVOICE_TO_NABIS]

    Reason for the last non-payment for this order