PATCH
/
shipping
/
{shipmethodId}
curl --request PATCH \
  --url https://prod01.oms.fabric.inc/api/v2/shipping/{shipmethodId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '{
  "shippingMethodId": "5349b4ddd2781d08c09890f4",
  "name": "Express Delivery",
  "description": "Express Delivery 2 - 5 days",
  "taxCode": "tax_1",
  "minimumDays": 2,
  "maximumDays": 5,
  "cutOffTime": 1330,
  "cost": 20,
  "channel": "12",
  "region": "CA",
  "deleted": false,
  "createdBy": "User1",
  "updatedBy": "User2",
  "configuredBy": "User3",
  "addressType": "APO",
  "weight": {
    "min": 2,
    "max": 3
  },
  "cartValue": {
    "min": 2,
    "max": 3
  },
  "dimension": {
    "min": {
      "height": 2,
      "width": 3,
      "length": 4
    },
    "max": {
      "height": 2,
      "width": 3,
      "length": 4
    }
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}'
{
  "shippingMethodId": "5349b4ddd2781d08c09890f4",
  "name": "Express Delivery",
  "description": "Express Delivery 2 - 5 days",
  "taxCode": "tax_1",
  "minimumDays": 2,
  "maximumDays": 5,
  "cutOffTime": 1330,
  "cost": 20,
  "channel": "12",
  "region": "CA",
  "deleted": false,
  "createdBy": "User1",
  "updatedBy": "User2",
  "configuredBy": "User3",
  "addressType": "APO",
  "weight": {
    "min": 2,
    "max": 3
  },
  "cartValue": {
    "min": 2,
    "max": 3
  },
  "dimension": {
    "min": {
      "height": 2,
      "width": 3,
      "length": 4
    },
    "max": {
      "height": 2,
      "width": 3,
      "length": 4
    }
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Path Parameters

​
shipmethodId
string
required

24-character system-generated unique ID of shipping method

Body

application/json

Details of shipping method

Response

200
application/json

OK

Details of shipping method

PATCH
/
shipping
/
{shipmethodId}
curl --request PATCH \
  --url https://prod01.oms.fabric.inc/api/v2/shipping/{shipmethodId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '{
  "shippingMethodId": "5349b4ddd2781d08c09890f4",
  "name": "Express Delivery",
  "description": "Express Delivery 2 - 5 days",
  "taxCode": "tax_1",
  "minimumDays": 2,
  "maximumDays": 5,
  "cutOffTime": 1330,
  "cost": 20,
  "channel": "12",
  "region": "CA",
  "deleted": false,
  "createdBy": "User1",
  "updatedBy": "User2",
  "configuredBy": "User3",
  "addressType": "APO",
  "weight": {
    "min": 2,
    "max": 3
  },
  "cartValue": {
    "min": 2,
    "max": 3
  },
  "dimension": {
    "min": {
      "height": 2,
      "width": 3,
      "length": 4
    },
    "max": {
      "height": 2,
      "width": 3,
      "length": 4
    }
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}'
{
  "shippingMethodId": "5349b4ddd2781d08c09890f4",
  "name": "Express Delivery",
  "description": "Express Delivery 2 - 5 days",
  "taxCode": "tax_1",
  "minimumDays": 2,
  "maximumDays": 5,
  "cutOffTime": 1330,
  "cost": 20,
  "channel": "12",
  "region": "CA",
  "deleted": false,
  "createdBy": "User1",
  "updatedBy": "User2",
  "configuredBy": "User3",
  "addressType": "APO",
  "weight": {
    "min": 2,
    "max": 3
  },
  "cartValue": {
    "min": 2,
    "max": 3
  },
  "dimension": {
    "min": {
      "height": 2,
      "width": 3,
      "length": 4
    },
    "max": {
      "height": 2,
      "width": 3,
      "length": 4
    }
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Path Parameters

​
shipmethodId
string
required

24-character system-generated unique ID of shipping method

Body

application/json

Details of shipping method

Response

200
application/json

OK

Details of shipping method