Get Many Shipment Mappings
Get multiple shipment mappings with pagination and filtering
Mappings with the same order_by value are sorted by ID, so pages do not overlap or skip mappings while the data is unchanged. To change many mappings, request pages until has_next_page is false and collect the IDs before changing any of them. Changing a mapping so it no longer matches your filters moves later mappings onto earlier pages.
Authorization
api_key In: header
Query Parameters
Page number for pagination (starting from 0)
double0Number of items per page (1-50)
double20Search term matched against the shipping method, carrier ID, and service ID
""Filter by must ship option (comma-separated for multiple)
""Filter by shop IDs (comma-separated for multiple)
""Filter for wildcard mappings
Filter for mappings that enforce cutoff time
Filter for enabled or disabled mappings (newly discovered shipping methods start disabled)
Field to order results by
"created_at"Value in
- "created_at"
- "updated_at"
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_type": "SHOPIFY", "shop_name": "string", "shop_id": "string", "rate_shop_name": "string", "rate_shop_id": "string", "service_id": "string", "carrier_id": "string", "carrier_integration_type": "GENERIC", "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", "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 }}