Skip to main content

Get Many Orders (NY)​

Please reach out to partnerships@nabis.com for information on API access.

Query Parameters
  • 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

  • warehouseId uuid

    Order Warehouse

  • 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 string

    System-generated numeric ID for order

  • lineItemId string

    Unique ID of each line-item on order

  • orderAction string

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

  • status string

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

  • creator string

    Email address of user that submitted order

  • retailer string

    Name of order destination

  • siteAddress string

    Address of order destination

  • 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).

  • creditMemo number
  • skuCode string

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

  • units number

    Number of units per line-item on order

  • pricePerUnit number

    Line-Item price per unit $ value on order

  • lineItemSubtotal number

    Subtotal gross $ amount for a line item (equals order_line_item.quantity * order_line_item.price_per_unit)

  • taxInclusiveLineItemSubtotal number

    The tax inclusive subtotal for the line item

  • lineItemUpdatedAt date-time

    Most recent date upon which line item details were adjusted

  • batchNumber string

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

  • batchExpiration date-time

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

  • inventoryCategory string

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

  • inventoryClass string

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

  • inventoryType string

    If the item is cannabis or non-cannabis

  • skuIsArchived boolean

    If the line-item is archived

  • exciseTax number

    $ Amount of the Excise Tax the line item incurred from the sale of cannabis products

  • paymentStatus string

    Description of the payment status of an order

  • notes string

    Brand-input notes regarding delivery instructions / requirements

  • manifest string

    URL for order PDF documentation

  • retailerId uuid

    System-generated unique ID of order destination

  • pocName string

    Point Of Contact name details

  • pocEmail string

    Point Of Contact email address

  • pocPhoneNumber string

    Point Of Contact phone number

  • paymentTerms string

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

  • skuBatchId uuid

    System-generated UUID for SkuBatch identifier

  • brandName string

    Brand Name

  • batchThcPercentage number

    % THC value of batch

  • 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.

  • wholesaleValue number

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

  • lineItemWholesaleValue number

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

  • 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.

  • posoNumber string

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

  • unitDescription string

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

  • subtotalCollected number

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

  • orderTaxAmount number

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

  • invoiceDueDate number

    Invoice due date

  • sample boolean

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

  • organization string

    Name of Brand organization

  • orderName string

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • retailerParentOrganization string

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • manufacturerLicenseNumber string

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • titleholderLicenseNumber string

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • orderDiscount number

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • surcharge number

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • strain string

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • standardPricePerUnit number

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • lineItemDiscount number

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • lineItemNotes string

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • daysTillPaymentDue number

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • remittedAt date-time

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • paidAt date-time

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • retailerParentOrganizationId string

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • fromMarketplace string

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • isSampleDemo string

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • orderInventoryStatus string

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • soldBy string

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • batchAromas string

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • batchTags string

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • batchThcAPercentage number

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • retailerCreditRating string

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • lineItemSubtotalAfterDiscount number

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • lineItemPricePerUnitAfterDiscount number

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • lineItemPriceDifference number

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • orderTsPerLine number

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • totalTsPerLine number

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • priceReduction number

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • skuDisplayName string

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • skuTags string[]

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • mustPayPriorBalance string

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • nabisNotes string

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • lastNonPaymentDate string

    Field retained for CA compatibility. Always null in V2 (NY) platform.

  • lastNonPaymentReason string

    Field retained for CA compatibility. Always null in V2 (NY) platform.