GET
/
api-shipping
/
shipping
/
all
curl --request GET \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-shipping/shipping/all \
  --header 'x-site-context: <x-site-context>'
[
  {
    "addressType": [
      "PO",
      "Business",
      "Residence",
      "APO",
      "MPO"
    ],
    "channel": [
      12
    ],
    "name": "2 Day",
    "description": "2 Day - guaranteed 2 day delivery by 9pm",
    "taxCode": "FR020000",
    "minimumDays": 1,
    "maximumDays": 2,
    "cutOffTime": 2100,
    "cost": 11.99,
    "regoin": "USA",
    "createdBy": "41224d776a326fb40f000001",
    "shippingMethodId": 10002,
    "__v": 0,
    "_id": "5fee9d59f2f08a1b3cbdea08",
    "createdAt": "2020-12-31T02:09:53.914Z",
    "updatedAt": "2020-12-31T02:09:53.914Z"
  }
]

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\"}"

Query Parameters

​
addressType
string

shipping method addressType

​
channel
string

shipping method channel

​
region
string

shipping method region

​
deleted
boolean

shipping method deleted

Response

200
application/json
Shipping Methods
​
addressType
string[]
Example:
["PO", "Business", "Residence", "APO", "MPO"]
​
channel
integer[]
​
name
string
Example:

"2 Day"

​
description
string
Example:

"2 Day - guaranteed 2 day delivery by 9pm"

​
taxCode
string
Example:

"FR020000"

​
minimumDays
number
Example:

1

​
maximumDays
number
Example:

2

​
cutOffTime
number
Example:

2100

​
cost
number
Example:

11.99

​
regoin
string
Example:

"USA"

​
createdBy
string
Example:

"41224d776a326fb40f000001"

​
shippingMethodId
number
Example:

10002

​
__v
number
Example:

0

​
_id
string
Example:

"5fee9d59f2f08a1b3cbdea08"

​
createdAt
string
Example:

"2020-12-31T02:09:53.914Z"

​
updatedAt
string
Example:

"2020-12-31T02:09:53.914Z"

Was this page helpful?