ShippingShipment mappings
Get Many Shipment Mappings
Get multiple shipment mappings with pagination and filtering
Authorization
api_key x-access-token<token>
In: header
Query Parameters
page?number
Page number for pagination (starting from 0)
Format
doubleDefault
0limit?number
Number of items per page
Format
doubleDefault
20search?string
Search term to filter shipment mappings by shipping method
Default
""must_ship?string
Filter by must ship option (comma-separated for multiple)
Default
""shop_id?string
Filter by shop IDs (comma-separated for multiple)
Default
""wildcard?boolean
Filter for wildcard mappings
enforce_cutoff?boolean
Filter for mappings that enforce cutoff time
order_by?string
Field to order results by
Default
"created_at"Value in
- "created_at"
- "updated_at"
order?string
Order direction
Value in
- "asc"
- "desc"
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/shipos/shipment-mappings"{ "data": [ { "team_name": "string", "team_id": "string", "shop_name": "string", "shop_id": "string", "rate_shop_name": "string", "rate_shop_id": "string", "service_id": "string", "carrier_id": "string", "carrier_integration_name": "string", "carrier_integration_id": "string", "enabled": true, "enforce_cutoff": true, "must_ship": "SAME_DAY", "cutoff_time": "string", "wildcard": true, "shipping_method": "string", "updated_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "id": "string", "shop": { "authorization_expires_at": "2019-08-24T14:15:22Z", "order_sync_start_date": "2019-08-24T14:15:22Z", "inventory_sync_enabled": true, "synced_at": "2019-08-24T14:15:22Z", "remote_slug": "string", "remote_id": "string", "uninstalled_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "slug": "string", "country": "string", "domain": "string", "currency": "string", "team_name": "string", "team_id": "string", "fulfiller_team_name": "string", "fulfiller_team_id": "string", "merchant_team_name": "string", "merchant_team_id": "string", "type": "SHOPIFY", "name": "string", "id": "string" }, "carrier_integration": { "id": "string", "name": "string", "type": "GENERIC", "team_id": "string", "active": true, "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z", "team_name": "string" }, "supported_actions": [ { "action": "VIEW_SHIPMENT_MAPPING" } ] } ], "meta": { "page": 0.1, "page_size": 0.1, "has_next_page": true, "has_previous_page": true, "start_index": 0.1, "end_index": 0.1 }}