Skip to main content
Version: v3

Get Many Orders​

Returns your organization's orders, newest first. Line items and financial details are available from their own endpoints.

To look up an order by the order number shown in the Nabis app and on order documents, pass orderNumber. You get a page holding just that order, or an empty page if your organization has no order with that number:

curl "https://customer-api.nabis.pro/v3/orders?page=0&limit=10&orderNumber=123456" \
-H 'x-nabis-access-token: <access-token>'
Query Parameters
  • page integer required

    Page to return. Pages start at 0

  • limit integer required

    Possible values: >= 1 and <= 500

    Number of records per page, up to 500

  • startCreatedAt date

    Only return orders created on or after this date, in yyyy-mm-dd format

  • endCreatedAt date

    Only return orders created on or before this date, in yyyy-mm-dd format

  • startUpdatedAt date

    Only return orders updated on or after this date, in yyyy-mm-dd format

  • endUpdatedAt date

    Only return orders updated on or before this date, in yyyy-mm-dd format

  • startDeliveryDate date

    Only return orders delivered on or after this date, in yyyy-mm-dd format

  • endDeliveryDate date

    Only return orders delivered on or before this date, in yyyy-mm-dd format

  • status string

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

    Only return orders with this status

  • action string

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

    Only return orders with this action

  • referrer string

    Possible values: [BRAND, RETAILER, PARTNER, MANUFACTURER]

    Only return orders placed by this kind of organization

  • paymentTerms string

    Possible values: [COD, NET_7, NET_10, NET_14, NET_15, NET_21, NET_28, NET_30, NET_45, NET_60, NET_90]

    Only return orders with these payment terms

  • warehouseId uuid

    Only return orders fulfilled from this Nabis warehouse

  • licensedLocationId uuid

    Only return orders for this retailer

  • orderNumber integer

    Possible values: >= 1

    Only return the order with this order number, as shown in the Nabis app and on order documents

Responses

Successful Operation

Response Headers
  • X-RateLimit-Limit integer

    Requests per minute your access token can make

  • X-RateLimit-Remaining integer

    Requests you can still make right now, after this one

  • X-RateLimit-Reset integer

    Seconds until your oldest request in the last minute stops counting, freeing up room for another. Not a countdown to your whole limit refilling: each request stops counting one minute after you make it


Schema
  • data object[]
  • id uuid

    Nabis ID of the order

  • orderNumber integer

    Order number shown in the Nabis app and on order documents

  • name string

    Name given to the order

  • action string

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

    Type of movement the order represents

  • status string

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

    Delivery status of the order

  • referrer string

    Possible values: [BRAND, RETAILER, PARTNER, MANUFACTURER]

    Kind of organization that placed the order

  • irn string

    Retailer's purchase order (PO/SO) number for the order

  • isSampleDemo boolean

    Whether the order is a sample or demo order

  • createdAt date-time

    When the order was created

  • updatedAt date-time

    When the order was last updated

  • deliveryDate date

    Scheduled delivery date of the order, in yyyy-mm-dd format

  • warehouseId uuid

    Nabis ID of the warehouse the order is fulfilled from

  • licensedLocationId uuid

    Nabis ID of the retailer the order is for. See Get Retailer by Nabis ID

  • licenseId uuid

    Nabis ID of the retailer license used for the order. See Get Retailer Licenses

  • creatorEmail string

    Email of the user who created the order

  • assigneeEmail string

    Email of the sales rep assigned to the order

  • paymentTerms string

    Possible values: [COD, NET_7, NET_10, NET_14, NET_15, NET_21, NET_28, NET_30, NET_45, NET_60, NET_90]

    When payment is due, relative to delivery. COD is due on delivery

  • mustPayPriorBalance boolean

    Whether the retailer must pay their prior balance before the order is delivered

  • taxInclusivePricing boolean

    Whether the order's prices include tax

  • notes string

    Notes on the order

  • nabisManifestNotes string

    Notes Nabis added to the order's manifest

  • manifestLink string

    Link to download the order's shipping manifest. null until a manifest is generated

  • contacts object[]

    Retailer contacts for the order

  • id uuid

    Nabis ID of the contact

  • firstName string

    First name of the contact

  • lastName string

    Last name of the contact

  • title string

    Job title of the contact

  • phoneNumber string

    Phone number of the contact

  • email string

    Email of the contact

  • preferredContactMethod string

    Possible values: [PHONE, EMAIL, TEXT]

    How the contact prefers to be reached

  • page integer

    The page returned

  • totalCount integer

    Total number of records across all pages

  • totalNumPages integer

    Total number of pages

  • nextPage integer

    The next page, or null on the last page

  • prevPage integer

    The previous page, or null on the first page