ShippingShipment mappings

Update Shipment Mapping

Update a shipment mapping by ID

Only the fields you send change. Set enabled to false to disable a mapping without clearing its rate shop or carrier service: new fulfillment orders skip a disabled mapping and use the team's fallback cutoff and must-ship settings. Set enabled to true to use it again, which requires a rate shop or a complete carrier service (carrier_integration_id, carrier_id, and service_id). Setting rate_shop_id clears the carrier service fields, and setting a carrier service field clears rate_shop_id.

PATCH
/shipos/shipment-mappings/{shipment_mapping_id}
x-access-token<token>

In: header

Path Parameters

shipment_mapping_id*string

The ID of the shipment mapping to be updated

Request Body

application/json

The new values for the shipment mapping

The new values for the shipment mapping

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://example.com/shipos/shipment-mappings/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "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"}