The Batch Submit Delivery allows for bulk submission of deliveries. The current limit is 100 per API call.

Requested Attribute

Attribute

Data Type

Description

Required Format

uids

string

unique multicharacter identifier that refers to a singular lease/order

none

sku

string

retailer defined and specific stock keeping unit to identify the product/item in the cart

none

display_name

string

name of the item in the cart

none

unit_price

string or integer input, string output

cash price of and item at a quantity of 1

number

quantity

integer

number of a speicfic item in the cart

number

delivery_date

string

the expected date an item(s) will be delivered to the customer's shipping address

YYYY-MM-DD

Requested Payload

{
  "uids": {
    "1234567890": {
    "items":[{
      "sku": "285868",
      "display_name": "BATTERY",
      "unit_price": 4.0,
      "quantity": 4,
     },
     {
      "sku": "12345",
      "display_name": "SOFA",
      "unit_price": 500.0,
      "quantity": 1,
     }]
     "delivery_date": "2016-10-14T13:40:16.368888"
    },
    "ab12345": {
      "items":[{
        "sku": "285868",
        "display_name": "BATTERY",
        "unit_price": 4.0,
        "quantity": 4,
        }]
      "delivery_date": "2016-10-17T13:40:16.368888"
      }
    }
  }

Multiple Delivery Submits Errors

Errors

HTTP Status

Description

BAD REQUEST

400

Validation Error / Invalid Items in Request Payload / Invalid uid /Transaction not found / Missing Mandatory Parameters

UNAUTHORIZED

401

Invalid Authorization Token

Language
Authentication
Bearer
URL