shipments

Shipments - Csv Export

Changed on

Export shipments data as a CSV file within a specified date range.

get/s/job/shipments/csv_export

Request

  • Base URL
    https://app.skulabs.com
  • URL
    https://app.skulabs.com/s/job/shipments/csv_export
  • Auth
    HTTP bearer

Query parameters

store_idsstring[] required

Store IDs to export shipments from

[
  "507f1f77bcf86cd799439011"
]
startstring required

Start date (ISO 8601)

Example:2025-01-01T00:00:00.000Z
endstring required

End date (ISO 8601)

Example:2025-01-31T23:59:59.000Z
warehouse_idsstring[]

Filter by warehouse IDs

order_levelboolean

Include order-level financial data (subtotal, shipping, discount, tax, total)

shipment_itemsboolean

Include a separate shipment items CSV with per-item detail

shipments_no_itemsboolean

Include itemless shipments when filtering by warehouse

shipments_no_locationboolean

Include shipments with no location when filtering by warehouse

carrier_account_idsstring[]

Carrier account IDs to include; 'null' = manual shipments. Omit or leave empty to include all carriers.

exclude_draft_shipmentsboolean

Exclude draft shipments (state unshipped or shipping; label never purchased)

exclude_failed_shipmentsboolean

Exclude shipments whose state is failed (failed label attempts)

exclude_voided_shipmentsboolean

Exclude real voided shipments (purchased then voided: state shipped and voided)

Response

Presigned S3 URLs for the generated CSV files

shipmentstring

S3 URL for shipments CSV export

shipment_itemsstring

S3 URL for shipment items CSV export

Changes