Create Shipment Mapping

Create a new shipment mapping

Authorization

api_key

x-access-token<token>

In: header

Request Body

application/json

The fields needed to create a shipment mapping

shipping_method*string

The shipping method name to match against

wildcard?boolean

Whether this is a wildcard match (e.g., "usps_" matches "usps_ground")

cutoff_time?string

The cutoff time in HH:mm format (e.g., "14:00")

must_ship?APIMustShip

When the order must ship by

Value in

"SAME_DAY"
"NEXT_DAY"
"IN_TWO_DAYS"

enforce_cutoff?boolean

Whether to enforce the cutoff time for SLA

enabled?boolean

Whether this shipment mapping is enabled for runtime routing

carrier_integration_id?|

The carrier integration to use for purchasing labels

carrier_id?|

The carrier ID for the shipping service

service_id?|

The service ID for the shipping service

rate_shop_id?|

The rate shop profile ID for dynamic rate selection

shop_id?|

The specific shop to match on (null for all shops)

Response Body

`application/json`

`application/problem+json`

curl -X POST "https://example.com/shipos/shipment-mappings" \  -H "Content-Type: application/json" \  -d '{    "shipping_method": "string"  }'

{  "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"    }  ]}

Authorization

Request Body

Response Body

201application/json

400application/problem+json

401application/problem+json

403application/problem+json

429application/problem+json

500application/problem+json

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`