Create Transaction Item Shipments

POST /v1/transactions/{externalTransactionID}/items/{externalItemID}/shipments

Bearer

Body Required

externalWarehouseID is required

externalWarehouseID string

External ID of the warehouse where items were allocated
quantity integer

Quantity shipped
shipmentDate string(date-time)

Date the shipment was created
shipmentID string

External ID of the shipment

Responses

201

Created
Hide response attributes Show response attributes object
- error string
- message string
- statusCode integer
default

All errors will return the same object with a describing code & message
Hide response attributes Show response attributes object
- error string
- message string
- statusCode integer

POST /v1/transactions/{externalTransactionID}/items/{externalItemID}/shipments

curl \
 -X POST https://ma-api.maddenanalytics.com/v1/transactions/{externalTransactionID}/items/{externalItemID}/shipments \
 -H "Authorization: $API_KEY" \
 -d '{"externalWarehouseID":"central-ws","quantity":1,"shipmentDate":"2022-08-17T16:50:50+02:00","shipmentID":"779644-1"}'

Request example

{
  "externalWarehouseID": "central-ws",
  "quantity": 1,
  "shipmentDate": "2022-08-17T16:50:50+02:00",
  "shipmentID": "779644-1"
}

Response examples (201)

{
  "error": "Error Type (if any)",
  "message": "Message describing the error",
  "statusCode": 400
}

Response examples (default)

{
  "error": "Error Type (if any)",
  "message": "Message describing the error",
  "statusCode": 400
}