Event for a parcel tracking update.
Return a 200 status to indicate that the data was received successfully
{- "logisticsAccountId": "string",
- "logisticsEventId": "string",
- "logisticsEventType": "string",
- "logisticsEventTime": "string",
- "trackingCode": "string",
- "status": "string",
- "message": "string",
- "eventTime": "string",
- "location": {
- "city": "string",
- "state": "string",
- "country": "string",
- "zip": "string"
}
}
Event when a return order has been updated.
Return a 200 status to indicate that the data was received successfully
{- "id": 0,
- "status": "CREATED",
- "sourceAddress": {
- "name": "string",
- "company": "string",
- "street1": "string",
- "street2": "string",
- "city": "string",
- "zip": "string",
- "state": "string",
- "country": "string",
- "phone": "string",
- "email": "string",
- "isResidential": true
}, - "shippingLabel": {
- "carrier": "string",
- "trackingCode": "string",
- "trackingUrl": "string",
- "labelUrl": "string",
- "trackingStatus": "CREATED"
}, - "rma": "string",
- "externalReturnId": "string",
- "returnItems": [
- {
- "identifier": "string",
- "expectedQuantity": 0,
- "inspectedItems": [
- {
- "receivedCondition": "string",
- "finalCondition": "string",
- "disposition": "string"
}
]
}
], - "shippedAt": "2019-08-24T14:15:22Z",
- "receivedAt": "2019-08-24T14:15:22Z",
- "inspectedAt": "2019-08-24T14:15:22Z",
- "logisticsAccountId": "string",
- "logisticsEventId": "string",
- "logisticsEventType": "string",
- "logisticsEventTime": "string"
}
Event when inventory changed.
logisticsAccountId required | string Logistics account ID | ||||||||||||||||||||
logisticsEventId required | string Logistics event ID | ||||||||||||||||||||
logisticsEventType required | string Event type | ||||||||||||||||||||
logisticsEventTime required | string Time when the event occurred | ||||||||||||||||||||
adjustmentId required | string | ||||||||||||||||||||
reason required | string
| ||||||||||||||||||||
required | Array of objects (Adjustment) | ||||||||||||||||||||
Return a 200 status to indicate that the data was received successfully
{- "logisticsAccountId": "string",
- "logisticsEventId": "string",
- "logisticsEventType": "string",
- "logisticsEventTime": "string",
- "adjustmentId": "string",
- "reason": "string",
- "adjustments": [
- {
- "logisticsSKU": "stringstrin",
- "changes": [
- {
- "state": "AVAILABLE",
- "delta": 0
}
]
}
]
}
Event when a new shipment was created.
logisticsAccountId required | string Logistics account ID |
logisticsEventId required | string Logistics event ID |
logisticsEventType required | string Event type |
logisticsEventTime required | string Time when the event occurred |
id required | string (ShipmentIdType) ^\d+$ A unique identifier for this shipment. |
orderId required | string (OrderIdType) ^\d+$ A unique identifier for this order. |
externalOrderId required | string (ExternalOrderIdType) A unique order reference meaningful to the external system submitting the order. |
Return a 200 status to indicate that the data was received successfully
{- "logisticsAccountId": "string",
- "logisticsEventId": "string",
- "logisticsEventType": "string",
- "logisticsEventTime": "string",
- "id": "string",
- "orderId": "string",
- "externalOrderId": "string"
}
Event when a new shipment was cancelled.
logisticsAccountId required | string Logistics account ID |
logisticsEventId required | string Logistics event ID |
logisticsEventType required | string Event type |
logisticsEventTime required | string Time when the event occurred |
id required | string (ShipmentIdType) ^\d+$ A unique identifier for this shipment. |
orderId required | string (OrderIdType) ^\d+$ A unique identifier for this order. |
externalOrderId required | string (ExternalOrderIdType) A unique order reference meaningful to the external system submitting the order. |
Return a 200 status to indicate that the data was received successfully
{- "logisticsAccountId": "string",
- "logisticsEventId": "string",
- "logisticsEventType": "string",
- "logisticsEventTime": "string",
- "id": "string",
- "orderId": "string",
- "externalOrderId": "string"
}
Order may contain one or more shipments. Each shipment triggers a Shipment.Shipped event. After the entire order ships, Order.Shipped is triggered.
logisticsAccountId required | string Logistics account ID |
logisticsEventId required | string Logistics event ID |
logisticsEventType required | string Event type |
logisticsEventTime required | string Time when the event occurred |
id required | string (ShipmentIdType) ^\d+$ A unique identifier for this shipment. |
orderId required | string (OrderIdType) ^\d+$ A unique identifier for this order. |
externalOrderId required | string (ExternalOrderIdType) A unique order reference meaningful to the external system submitting the order. |
Return a 200 status to indicate that the data was received successfully
{- "logisticsAccountId": "string",
- "logisticsEventId": "string",
- "logisticsEventType": "string",
- "logisticsEventTime": "string",
- "id": "string",
- "orderId": "string",
- "externalOrderId": "string"
}
Event when a new shipment was partially shipped.
logisticsAccountId required | string Logistics account ID |
logisticsEventId required | string Logistics event ID |
logisticsEventType required | string Event type |
logisticsEventTime required | string Time when the event occurred |
id required | string (ShipmentIdType) ^\d+$ A unique identifier for this shipment. |
orderId required | string (OrderIdType) ^\d+$ A unique identifier for this order. |
externalOrderId required | string (ExternalOrderIdType) A unique order reference meaningful to the external system submitting the order. |
Return a 200 status to indicate that the data was received successfully
{- "logisticsAccountId": "string",
- "logisticsEventId": "string",
- "logisticsEventType": "string",
- "logisticsEventTime": "string",
- "id": "string",
- "orderId": "string",
- "externalOrderId": "string"
}
Event when an inbound was received.
logisticsAccountId required | string Logistics account ID |
logisticsEventId required | string Logistics event ID |
logisticsEventType required | string Event type |
logisticsEventTime required | string Time when the event occurred |
type required | string Enum: "SELLABLE" "DAMAGED" |
amount required | integer <int32> |
shipmentItemId required | integer <int32> |
Return a 200 status to indicate that the data was received successfully
{- "logisticsAccountId": "string",
- "logisticsEventId": "string",
- "logisticsEventType": "string",
- "logisticsEventTime": "string",
- "type": "SELLABLE",
- "amount": 0,
- "shipmentItemId": 0
}
Event when an inbound shipment status has changed.
logisticsAccountId required | string Logistics account ID |
logisticsEventId required | string Logistics event ID |
logisticsEventType required | string Event type |
logisticsEventTime required | string Time when the event occurred |
status required | string |
shipmentId required | string (ShipmentIdType) ^\d+$ A unique identifier for this shipment. |
Return a 200 status to indicate that the data was received successfully
{- "logisticsAccountId": "string",
- "logisticsEventId": "string",
- "logisticsEventType": "string",
- "logisticsEventTime": "string",
- "status": "string",
- "shipmentId": "string"
}
Event for a freight tracking update.
required | object (FreightStopDetails) | ||||||||||
| |||||||||||
required | object (FreightStopDetails) | ||||||||||
| |||||||||||
bolId required | string | ||||||||||
mode required | string (FreightShipmentMode) Enum: "LTL" "FTL" "DRAYAGE" "INTERMODAL" "TRANSLOAD" "VLTL" "FCL" "LCL" | ||||||||||
bolStatus required | string (FreightBolStatus) Enum: "CANCELLED" "TENDERED" "CREATED" "IN_TRANSIT" "DELIVERED" | ||||||||||
carrierName | string | ||||||||||
estimatedPickupTime | string <date-time> | ||||||||||
estimatedDeliveryTime | string <date-time> | ||||||||||
estimatedPortDepartureTime | string <date-time> | ||||||||||
estimatedPortArrivalTime | string <date-time> | ||||||||||
totalPallets | number <double> | ||||||||||
required | Array of objects (FreightTrackingEvent) | ||||||||||
Array
| |||||||||||
updatedAt required | string <date-time> |
Return a 200 status to indicate that the data was received successfully
{- "pickupDetails": {
- "appointmentWindow": {
- "startTime": "string",
- "endTime": "string",
- "date": "string"
}, - "address": {
- "name": "string",
- "company": "string",
- "street1": "string",
- "street2": "string",
- "city": "string",
- "zip": "string",
- "state": "string",
- "country": "string",
- "phone": "string",
- "email": "string",
- "isResidential": true
}
}, - "deliveryDetails": {
- "appointmentWindow": {
- "startTime": "string",
- "endTime": "string",
- "date": "string"
}, - "address": {
- "name": "string",
- "company": "string",
- "street1": "string",
- "street2": "string",
- "city": "string",
- "zip": "string",
- "state": "string",
- "country": "string",
- "phone": "string",
- "email": "string",
- "isResidential": true
}
}, - "bolId": "string",
- "mode": "LTL",
- "bolStatus": "CANCELLED",
- "carrierName": "string",
- "estimatedPickupTime": "2019-08-24T14:15:22Z",
- "estimatedDeliveryTime": "2019-08-24T14:15:22Z",
- "estimatedPortDepartureTime": "2019-08-24T14:15:22Z",
- "estimatedPortArrivalTime": "2019-08-24T14:15:22Z",
- "totalPallets": 0,
- "events": [
- {
- "occurredAt": "2019-08-24T14:15:22Z",
- "location": {
- "name": "string",
- "street1": "string",
- "street2": "string",
- "city": "string",
- "zip": "string",
- "state": "string",
- "country": "string",
- "timezone": "string",
- "latitude": 0,
- "longitude": 0
}, - "eventType": "CANCELLED",
- "bolStatus": "CANCELLED",
- "address": {
- "name": "string",
- "company": "string",
- "street1": "string",
- "street2": "string",
- "city": "string",
- "zip": "string",
- "state": "string",
- "country": "string",
- "phone": "string",
- "email": "string",
- "isResidential": true
}
}
], - "updatedAt": "2019-08-24T14:15:22Z"
}
Event if an order was cancelled.
logisticsAccountId required | string Logistics account ID |
logisticsEventId required | string Logistics event ID |
logisticsEventType required | string Event type |
logisticsEventTime required | string Time when the event occurred |
id required | string (OrderIdType) ^\d+$ A unique identifier for this order. |
orderId required | string (OrderIdType) ^\d+$ A unique identifier for this order. |
externalOrderId required | string (ExternalOrderIdType) A unique order reference meaningful to the external system submitting the order. |
Return a 200 status to indicate that the data was received successfully
{- "logisticsAccountId": "string",
- "logisticsEventId": "string",
- "logisticsEventType": "string",
- "logisticsEventTime": "string",
- "id": "string",
- "orderId": "string",
- "externalOrderId": "string"
}
Order.Shipped is sent when the entire order has shipped. If order consists of multiple shipments, each shipment also triggers a Shipment.Shipped event.
logisticsAccountId required | string Logistics account ID |
logisticsEventId required | string Logistics event ID |
logisticsEventType required | string Event type |
logisticsEventTime required | string Time when the event occurred |
id required | string (OrderIdType) ^\d+$ A unique identifier for this order. |
orderId required | string (OrderIdType) ^\d+$ A unique identifier for this order. |
externalOrderId required | string (ExternalOrderIdType) A unique order reference meaningful to the external system submitting the order. |
Return a 200 status to indicate that the data was received successfully
{- "logisticsAccountId": "string",
- "logisticsEventId": "string",
- "logisticsEventType": "string",
- "logisticsEventTime": "string",
- "id": "string",
- "orderId": "string",
- "externalOrderId": "string"
}