GuidesAPI Reference
Log In
API Reference

Multi-Order Checkout

Use this call to trigger a checkout event for multiple orders that share a checkout location. For example, warehouse workers can use this call when they finish loading a vehicle, so that drivers can arrive and immediately start their route. This call updates any inventory information but does not start the orders.

To receive the details of the checkout, use the Async Operation Status API.

Path Params
string
required
string
required
Body Params
string

Your ID for the order.

string

Define if the driver is performing a pickup or delivery (dropoff) at the destination.

string

Your ID for the inventory item.

string

The amount of that item delivered.

string

The amount of that item not delivered.

string

Indicates the reasons given by the customer when rejecting inventory items.

int32

The checkout location's latitude coordinate.

int32

The checkout location's longitude coordinates.

date-time

The actual time the event happened. NOTE: Only to be used to report retrospect events.

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json