API docs by RedoclyNabis Platform Api (1.0.3)
Download OpenAPI specification:Download
Welcome to the Nabis Platform Api.
- All Api Access are rate limited (on a per minute basis)
- X-NABIS-RATELIMIT in the response header will show the remaning req limit
- x-nabis-access-token header is required for all api requests
- For Example:
curl --location --request GET 'https://api.getnabis.com/platform/v1/orders/detailed?page=1' --header 'x-nabis-access-token: 8f440f43260fc8e7e7db800c178c193d' - replace 8f440f43260fc8e7e7db800c178c193d with your provided access token
Get standard csv for all orders
your access token
query Parameters
| startDeliveryDate | string <date> PST timezone; MM-DD-YYYY (i.e startDeliveryDate=01-01-2021) |
| endDeliveryDate | string <date> PST timezone; MM-DD-YYYY (i.e endDeliveryDate=01-01-2021) |
| startCreatedAt | string <date> PST timezone; MM-DD-YYYY (i.e startCreatedAt=01-01-2021) |
| endCreatedAt | string <date> PST timezone; MM-DD-YYYY (i.e endCreatedAt=01-01-2021) |
| updatedAt | string <date> PST timezone; MM-DD-YYYY (i.e updatedAt=01-01-2021) |
| orderNumber | integer Order Number |
| orderNumber | string PO/SO |
| orderName | string Order Name |
| paymentStatus | string Enum: "COD_PAID" "NET_TERMS_PAID" "PROCESSING" "REMITTED" "SELF_COLLECTED" "UNPAID" Payment Status |
| paymentTerms | integer Enum: 0 7 14 15 30 45 60 90 Payment Terms; 0 implies COD |
| action | string Enum: "DELIVERY_TO_BRAND" "DELIVERY_TO_RETAILER" "DROPOFF_TO_NABIS" "INTERNAL_TRANSFER" "PICKUP_FROM_BRAND" "PICKUP_FROM_NABIS" Order Action |
| status | string Enum: "ATTEMPTED" "CANCELLED" "DELAYED" "DELIVERED" "DELIVERED_WITH_EDITS" "IN_TRANSIT" "REJECTED" "SCHEDULED" "TRANSFERRING" "UNSCHEDULED" Order Status |
| warehouse | string Enum: "NABIONE" "NORCAL" "SOCAL" Order Warehouse |
| referrer | string Enum: "BRAND" "RETAILER" Order Referrer |
header Parameters
| x-nabis-access-token required | string Nabis Access Token |
Responses
Get detailed csv for all orders
This endpoint is paginated, defaults to ?page=1 when no page query parameter is provided
query Parameters
| page required | integer used for pagination (i.e page=1) |
| startDeliveryDate | string <date> PST timezone; MM-DD-YYYY (i.e startDeliveryDate=01-01-2021) |
| endDeliveryDate | string <date> PST timezone; MM-DD-YYYY (i.e endDeliveryDate=01-01-2021) |
| startCreatedAt | string <date> PST timezone; MM-DD-YYYY (i.e startCreatedAt=01-01-2021) |
| endCreatedAt | string <date> PST timezone; MM-DD-YYYY (i.e endCreatedAt=01-01-2021) |
| updatedAt | string <date> PST timezone; MM-DD-YYYY (i.e updatedAt=01-01-2021) |
| orderNumber | integer Order Number |
| orderNumber | string PO/SO |
| orderName | string Order Name |
| paymentStatus | string Enum: "COD_PAID" "NET_TERMS_PAID" "PROCESSING" "REMITTED" "SELF_COLLECTED" "UNPAID" Payment Status |
| paymentTerms | integer Enum: 0 7 14 15 30 45 60 90 Payment Terms; 0 implies COD |
| action | string Enum: "DELIVERY_TO_BRAND" "DELIVERY_TO_RETAILER" "DROPOFF_TO_NABIS" "INTERNAL_TRANSFER" "PICKUP_FROM_BRAND" "PICKUP_FROM_NABIS" Order Action |
| status | string Enum: "ATTEMPTED" "CANCELLED" "DELAYED" "DELIVERED" "DELIVERED_WITH_EDITS" "IN_TRANSIT" "REJECTED" "SCHEDULED" "TRANSFERRING" "UNSCHEDULED" Order Status |
| warehouse | string Enum: "NABIONE" "NORCAL" "SOCAL" Order Warehouse |
| referrer | string Enum: "BRAND" "RETAILER" Order Referrer |
header Parameters
| x-nabis-access-token required | string Nabis Access Token |