Sign in
shipments

Shipments - Csv Export

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

get/s/job/shipments/csv_export

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

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

Changed in 6 of the 13 revisions of this API.5215

  • fa53dd949b8e1See the full diff
    • ○

      endpoint added

      endpoint-added

  • 3b410dd1cc4b1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

  • 5be88c3f42d31See the full diff
    • ○

      endpoint added

      endpoint-added

  • b02ec7e89f321See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

  • 08cd9cfa14dd23See the full diff
    • ▲

      for the query request parameter end, the type/format was changed from string/ to string/date

      request-parameter-type-changed

    • ▲

      for the query request parameter start, the type/format was changed from string/ to string/date

      request-parameter-type-changed

    • ○

      for the query request parameter store_ids, the type/format was generalized from string/ to array/

      request-parameter-type-generalized

    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

  • 46ceda5280001210See the full diff
    • ▲

      removed the media type application/json for the response with the status 200

      response-media-type-removed

    • ●

      deleted the query request parameter options

      request-parameter-removed

    • ●

      deleted the query request parameter warehouse_ids

      request-parameter-removed

    • ○

      api operation id get_shipments_csv_export removed and replaced with

      api-operation-id-removed

    • ○

      the query request parameter end became optional

      request-parameter-became-optional

    • ○

      the query request parameter start became optional

      request-parameter-became-optional

    • ○

      the query request parameter store_ids became optional

      request-parameter-became-optional

    • ○

      for the query request parameter store_ids, the type/format was generalized from array/ to string/

      request-parameter-type-generalized

    • ○

      removed the non-success response with the status 400

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 401

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 403

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 429

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 500

      response-non-success-status-removed

    This revision also has 85 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog