Shipping & Logistics

Shipments, packing, carrier integration, and logistics.

Shipments

Endpoints related to shipments.

GET /shipment/
Query Parameters:

  • limit (integer) – Maximum number of resources to return

  • offset (integer) – Number of resources to skip

  • sort (string) – Sort order (prefix with ‘-’ for descending)

Status Codes:

  • 200 OK – Successful response with list of resources

  • 404 Not Found – The requested Shipment (or related record) cannot be found.

  • 400 Bad Request – NotImplementedError Auto-generated shipment names cannot be renamed.

POST /shipment/

We don’t allow to create shipment via rest (for now).

We don’t allow to create shipment via rest (for now). Record should be created when run is created

Status Codes:

  • 201 Created – Resource created successfully

  • 404 Not Found – The requested Shipment (or related record) cannot be found.

  • 400 Bad Request – NotImplementedError Auto-generated shipment names cannot be renamed.

Response Headers:

  • Location – URI of the created resource

GET /shipment/{uuid}/
Parameters:

  • uuid (string) – The UUID of the resource

Status Codes:

  • 200 OK – Successful response

  • 404 Not Found – The requested Shipment (or related record) cannot be found.

  • 400 Bad Request – NotImplementedError Auto-generated shipment names cannot be renamed.

PUT /shipment/{uuid}/
Parameters:

  • uuid (string) – The UUID of the resource

Status Codes:

  • 204 No Content – Resource updated successfully

  • 404 Not Found – The requested Shipment (or related record) cannot be found.

  • 400 Bad Request – NotImplementedError Auto-generated shipment names cannot be renamed.

POST /shipment/split/

Split a shipment by creating a new shipping run for ready pieces.

Split a shipment by creating a new shipping run for ready pieces.

Status Codes:

  • 201 Created – Resource created successfully

  • 404 Not Found – shipment-split-error: An error occurred during the shipment splitting process

  • 400 Bad Request – pieces-invalid-or-not-ready: One or more pieces are invalid or not ready for shipping. This includes validation errors, pieces from different runs, and system state issues that prevent split shipping.

Response Headers:

  • Location – URI of the created resource

GET /shipment-packing-slip/
Query Parameters:

  • limit (integer) – Maximum number of resources to return

  • offset (integer) – Number of resources to skip

  • sort (string) – Sort order (prefix with ‘-’ for descending)

Status Codes:

  • 200 OK – Successful response with list of resources

  • 404 Not Found – The requested shipment packing slip or related order cannot be found.

  • 403 Forbidden – You are not authorized to complete the request.

POST /shipment-packing-slip/
Status Codes:

  • 201 Created – Resource created successfully

  • 404 Not Found – The requested shipment packing slip or related order cannot be found.

  • 403 Forbidden – You are not authorized to complete the request.

Response Headers:

  • Location – URI of the created resource

GET /shipment-packing-slip/{uuid}/
Parameters:

  • uuid (string) – The UUID of the resource

Status Codes:

  • 200 OK – Successful response

  • 404 Not Found – The requested shipment packing slip or related order cannot be found.

  • 403 Forbidden – You are not authorized to complete the request.

Packing

Endpoints related to packing.

GET /packing-process/
Query Parameters:

  • limit (integer) – Maximum number of resources to return

  • offset (integer) – Number of resources to skip

  • sort (string) – Sort order (prefix with ‘-’ for descending)

Status Codes:
POST /packing-process/
Status Codes:
Response Headers:

  • Location – URI of the created resource

GET /packing-process/{uuid}/
Parameters:

  • uuid (string) – The UUID of the resource

Status Codes:
PUT /packing-process/{uuid}/
Parameters:

  • uuid (string) – The UUID of the resource

Status Codes:
DELETE /packing-process/{uuid}/
Parameters:

  • uuid (string) – The UUID of the resource

Status Codes:

Logistics

Endpoints related to logistics.

GET /shipping/

List all of the shipping in the system for your account. Supports filtering by shipping_type, location, bureau.

List all of the shipping in the system for your account. Supports filtering by shipping_type, location, bureau.

Query Parameters:

  • limit (integer) – Maximum number of resources to return

  • offset (integer) – Number of resources to skip

  • sort (string) – Sort order (prefix with ‘-’ for descending)

Status Codes:

  • 200 OK – Successful response with list of resources

  • 404 Not Found – The requested shipping cannot be found.

  • 403 Forbidden – You are not authorized to complete the request. BureauMismatchError: There is a mismatch of your bureau and a bureau in the payload, or in the payload’s shipping_type/location.

  • 400 Bad Request – The value of bureau appears to be an invalid bureau. The requested shipping name for the region already exists. invalid-payload: Missed required fields for provided Batching Strategy. Cannot delete shipping that has runs in queue. Remove runs before deleting shipping.

POST /shipping/

Create a new shipping station (instance). Requires `shipping_type` and `location`.

Create a new shipping station (instance). Requires shipping_type and location.

Status Codes:

  • 201 Created – Resource created successfully

  • 404 Not Found – The requested shipping cannot be found.

  • 403 Forbidden – You are not authorized to complete the request. BureauMismatchError: There is a mismatch of your bureau and a bureau in the payload, or in the payload’s shipping_type/location.

  • 400 Bad Request – The value of bureau appears to be an invalid bureau. The requested shipping name for the region already exists. invalid-payload: Missed required fields for provided Batching Strategy. Cannot delete shipping that has runs in queue. Remove runs before deleting shipping.

Response Headers:

  • Location – URI of the created resource

GET /shipping/{uuid}/

Get an individual shipping resource by UUID.

Get an individual shipping resource by UUID.

Parameters:

  • uuid (string) – The UUID of the resource

Status Codes:

  • 200 OK – Successful response

  • 404 Not Found – The requested shipping cannot be found.

  • 403 Forbidden – You are not authorized to complete the request. BureauMismatchError: There is a mismatch of your bureau and a bureau in the payload, or in the payload’s shipping_type/location.

  • 400 Bad Request – The value of bureau appears to be an invalid bureau. The requested shipping name for the region already exists. invalid-payload: Missed required fields for provided Batching Strategy. Cannot delete shipping that has runs in queue. Remove runs before deleting shipping.

PUT /shipping/{uuid}/

Update a shipping by UUID.

Update a shipping by UUID.

Parameters:

  • uuid (string) – The UUID of the resource

Status Codes:

  • 204 No Content – Resource updated successfully

  • 404 Not Found – The requested shipping cannot be found.

  • 403 Forbidden – You are not authorized to complete the request. BureauMismatchError: There is a mismatch of your bureau and a bureau in the payload, or in the payload’s shipping_type/location.

  • 400 Bad Request – The value of bureau appears to be an invalid bureau. The requested shipping name for the region already exists. invalid-payload: Missed required fields for provided Batching Strategy. Cannot delete shipping that has runs in queue. Remove runs before deleting shipping.

DELETE /shipping/{uuid}/

Delete a shipping by UUID.

Delete a shipping by UUID.

Parameters:

  • uuid (string) – The UUID of the resource

Status Codes:

  • 204 No Content – Resource deleted successfully

  • 404 Not Found – The requested shipping cannot be found.

  • 403 Forbidden – You are not authorized to complete the request. BureauMismatchError: There is a mismatch of your bureau and a bureau in the payload, or in the payload’s shipping_type/location.

  • 400 Bad Request – The value of bureau appears to be an invalid bureau. The requested shipping name for the region already exists. invalid-payload: Missed required fields for provided Batching Strategy. Cannot delete shipping that has runs in queue. Remove runs before deleting shipping.