Skip to main content
GET
/
v1
/
shipping
/
retailers
/
{id}
Get one Retailer
curl --request GET \
  --url https://{base_url_domain}/api/global/v1/shipping/retailers/{id} \
  --header 'Authorization: Bearer <token>'
{
  "resource": {
    "type": "Retailer",
    "id": 123,
    "code": "walmart",
    "name": "Walmart",
    "status": "active",
    "fulfillment_model": "wholesale",
    "merchant": {
      "type": "Merchant",
      "id": 4,
      "code": "acme_inc",
      "name": "ACME Inc.",
      "status": "active",
      "created_at": "2017-07-21T17:32:28Z",
      "updated_at": "2017-07-21T17:39:43Z",
      "brands": [
        {
          "type": "Brand",
          "id": 4
        }
      ],
      "default_brand": {
        "type": "Brand",
        "id": 4
      },
      "custom_fields": {
        "is_gift": {
          "value": true
        },
        "order_details": {
          "value": "test details"
        },
        "department": {
          "id": 3,
          "label": "Shipping"
        },
        "priority_levels": [
          {
            "id": 1,
            "label": "Urgent"
          },
          {
            "id": 2,
            "label": "High"
          }
        ],
        "cost_of_goods": {
          "amount": 156.99,
          "currency": "USD"
        },
        "assigned_user": {
          "value": 42
        }
      }
    },
    "parent_retailer": {
      "type": "Retailer",
      "id": 2
    },
    "legal_name": "Walmart Inc.",
    "dba": "Walmart Marketplace",
    "default_duties_payor": "recipient",
    "default_shipping_method": "fedex_FEDEX_GROUND",
    "allowed_shipping_methods": [
      "fedex_FEDEX_GROUND",
      "ups_GND"
    ],
    "default_tpb_group_id": 5,
    "routing_guide_notes": "<string>",
    "custom_fields": {
      "is_gift": {
        "value": true
      },
      "order_details": {
        "value": "test details"
      },
      "department": {
        "id": 3,
        "label": "Shipping"
      },
      "priority_levels": [
        {
          "id": 1,
          "label": "Urgent"
        },
        {
          "id": 2,
          "label": "High"
        }
      ],
      "cost_of_goods": {
        "amount": 156.99,
        "currency": "USD"
      },
      "assigned_user": {
        "value": 42
      }
    },
    "created_at": "2017-07-21T17:32:28Z",
    "updated_at": "2017-07-21T17:39:43Z"
  },
  "included": {
    "Merchant": [
      {
        "type": "Merchant",
        "id": 4,
        "code": "acme_inc",
        "name": "ACME Inc.",
        "status": "active",
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z",
        "brands": [
          {
            "type": "Brand",
            "id": 4
          }
        ],
        "default_brand": {
          "type": "Brand",
          "id": 4
        },
        "custom_fields": {
          "is_gift": {
            "value": true
          },
          "order_details": {
            "value": "test details"
          },
          "department": {
            "id": 3,
            "label": "Shipping"
          },
          "priority_levels": [
            {
              "id": 1,
              "label": "Urgent"
            },
            {
              "id": 2,
              "label": "High"
            }
          ],
          "cost_of_goods": {
            "amount": 156.99,
            "currency": "USD"
          },
          "assigned_user": {
            "value": 42
          }
        }
      }
    ],
    "Retailer": [
      {
        "type": "Retailer",
        "id": 123,
        "code": "walmart",
        "name": "Walmart",
        "status": "active",
        "fulfillment_model": "wholesale",
        "merchant": {
          "type": "Merchant",
          "id": 4,
          "code": "acme_inc",
          "name": "ACME Inc.",
          "status": "active",
          "created_at": "2017-07-21T17:32:28Z",
          "updated_at": "2017-07-21T17:39:43Z",
          "brands": [
            {
              "type": "Brand",
              "id": 4
            }
          ],
          "default_brand": {
            "type": "Brand",
            "id": 4
          },
          "custom_fields": {
            "is_gift": {
              "value": true
            },
            "order_details": {
              "value": "test details"
            },
            "department": {
              "id": 3,
              "label": "Shipping"
            },
            "priority_levels": [
              {
                "id": 1,
                "label": "Urgent"
              },
              {
                "id": 2,
                "label": "High"
              }
            ],
            "cost_of_goods": {
              "amount": 156.99,
              "currency": "USD"
            },
            "assigned_user": {
              "value": 42
            }
          }
        },
        "parent_retailer": {
          "type": "Retailer",
          "id": 2
        },
        "legal_name": "Walmart Inc.",
        "dba": "Walmart Marketplace",
        "default_duties_payor": "recipient",
        "default_shipping_method": "fedex_FEDEX_GROUND",
        "allowed_shipping_methods": [
          "fedex_FEDEX_GROUND",
          "ups_GND"
        ],
        "default_tpb_group_id": 5,
        "routing_guide_notes": "<string>",
        "custom_fields": {
          "is_gift": {
            "value": true
          },
          "order_details": {
            "value": "test details"
          },
          "department": {
            "id": 3,
            "label": "Shipping"
          },
          "priority_levels": [
            {
              "id": 1,
              "label": "Urgent"
            },
            {
              "id": 2,
              "label": "High"
            }
          ],
          "cost_of_goods": {
            "amount": 156.99,
            "currency": "USD"
          },
          "assigned_user": {
            "value": 42
          }
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

​
id
integer<int32>
required

The id of the referenced Retailer.

Required range: x >= 1

Query Parameters

​
fields
enum<string>[]

Specify additional fields of the Retailer object to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
code,
name,
status,
fulfillment_model,
merchant,
parent_retailer,
legal_name,
dba,
default_duties_payor,
default_shipping_method,
allowed_shipping_methods,
default_tpb_group_id,
routing_guide_notes,
custom_fields,
created_at,
updated_at
​
fields:merchant
enum<string>[]

Specify additional fields of the Merchant object to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
code,
name,
status,
created_at,
updated_at,
brands,
default_brand,
custom_fields
​
fields:parent_retailer
enum<string>[]

Specify additional fields of the parent Retailer object to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
code,
name,
status,
fulfillment_model,
merchant,
parent_retailer,
legal_name,
dba,
default_duties_payor,
default_shipping_method,
allowed_shipping_methods,
default_tpb_group_id,
routing_guide_notes,
custom_fields,
created_at,
updated_at

Response

OK

​
resource
Retailer · object

A Retailer represents a B2B retail partner for a merchant, including fulfillment defaults and retailer-specific custom fields.

​
included
object

Lists of referenced objects included by specifying optional fields. See the selecting fields page for more information.