Update Retailer
curl --request PUT \
--url https://{base_url_domain}/api/global/v1/shipping/retailers/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"code": "walmart",
"name": "Walmart",
"status": "active",
"fulfillment_model": "wholesale",
"merchant": {
"code": "acme_inc",
"name": "ACME Inc.",
"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"
}
'import requests
url = "https://{base_url_domain}/api/global/v1/shipping/retailers/{id}"
payload = {
"code": "walmart",
"name": "Walmart",
"status": "active",
"fulfillment_model": "wholesale",
"merchant": {
"code": "acme_inc",
"name": "ACME Inc.",
"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"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
code: 'walmart',
name: 'Walmart',
status: 'active',
fulfillment_model: 'wholesale',
merchant: {
code: 'acme_inc',
name: 'ACME Inc.',
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'
})
};
fetch('https://{base_url_domain}/api/global/v1/shipping/retailers/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{base_url_domain}/api/global/v1/shipping/retailers/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'code' => 'walmart',
'name' => 'Walmart',
'status' => 'active',
'fulfillment_model' => 'wholesale',
'merchant' => [
'code' => 'acme_inc',
'name' => 'ACME Inc.',
'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'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{base_url_domain}/api/global/v1/shipping/retailers/{id}"
payload := strings.NewReader("{\n \"code\": \"walmart\",\n \"name\": \"Walmart\",\n \"status\": \"active\",\n \"fulfillment_model\": \"wholesale\",\n \"merchant\": {\n \"code\": \"acme_inc\",\n \"name\": \"ACME Inc.\",\n \"custom_fields\": {\n \"is_gift\": {\n \"value\": true\n },\n \"order_details\": {\n \"value\": \"test details\"\n },\n \"department\": {\n \"id\": 3,\n \"label\": \"Shipping\"\n },\n \"priority_levels\": [\n {\n \"id\": 1,\n \"label\": \"Urgent\"\n },\n {\n \"id\": 2,\n \"label\": \"High\"\n }\n ],\n \"cost_of_goods\": {\n \"amount\": 156.99,\n \"currency\": \"USD\"\n },\n \"assigned_user\": {\n \"value\": 42\n }\n }\n },\n \"parent_retailer\": {\n \"type\": \"Retailer\",\n \"id\": 2\n },\n \"legal_name\": \"Walmart Inc.\",\n \"dba\": \"Walmart Marketplace\",\n \"default_duties_payor\": \"recipient\",\n \"default_shipping_method\": \"fedex_FEDEX_GROUND\",\n \"allowed_shipping_methods\": [\n \"fedex_FEDEX_GROUND\",\n \"ups_GND\"\n ],\n \"default_tpb_group_id\": 5,\n \"routing_guide_notes\": \"<string>\",\n \"custom_fields\": {\n \"is_gift\": {\n \"value\": true\n },\n \"order_details\": {\n \"value\": \"test details\"\n },\n \"department\": {\n \"id\": 3,\n \"label\": \"Shipping\"\n },\n \"priority_levels\": [\n {\n \"id\": 1,\n \"label\": \"Urgent\"\n },\n {\n \"id\": 2,\n \"label\": \"High\"\n }\n ],\n \"cost_of_goods\": {\n \"amount\": 156.99,\n \"currency\": \"USD\"\n },\n \"assigned_user\": {\n \"value\": 42\n }\n },\n \"created_at\": \"2017-07-21T17:32:28Z\",\n \"updated_at\": \"2017-07-21T17:39:43Z\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://{base_url_domain}/api/global/v1/shipping/retailers/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"code\": \"walmart\",\n \"name\": \"Walmart\",\n \"status\": \"active\",\n \"fulfillment_model\": \"wholesale\",\n \"merchant\": {\n \"code\": \"acme_inc\",\n \"name\": \"ACME Inc.\",\n \"custom_fields\": {\n \"is_gift\": {\n \"value\": true\n },\n \"order_details\": {\n \"value\": \"test details\"\n },\n \"department\": {\n \"id\": 3,\n \"label\": \"Shipping\"\n },\n \"priority_levels\": [\n {\n \"id\": 1,\n \"label\": \"Urgent\"\n },\n {\n \"id\": 2,\n \"label\": \"High\"\n }\n ],\n \"cost_of_goods\": {\n \"amount\": 156.99,\n \"currency\": \"USD\"\n },\n \"assigned_user\": {\n \"value\": 42\n }\n }\n },\n \"parent_retailer\": {\n \"type\": \"Retailer\",\n \"id\": 2\n },\n \"legal_name\": \"Walmart Inc.\",\n \"dba\": \"Walmart Marketplace\",\n \"default_duties_payor\": \"recipient\",\n \"default_shipping_method\": \"fedex_FEDEX_GROUND\",\n \"allowed_shipping_methods\": [\n \"fedex_FEDEX_GROUND\",\n \"ups_GND\"\n ],\n \"default_tpb_group_id\": 5,\n \"routing_guide_notes\": \"<string>\",\n \"custom_fields\": {\n \"is_gift\": {\n \"value\": true\n },\n \"order_details\": {\n \"value\": \"test details\"\n },\n \"department\": {\n \"id\": 3,\n \"label\": \"Shipping\"\n },\n \"priority_levels\": [\n {\n \"id\": 1,\n \"label\": \"Urgent\"\n },\n {\n \"id\": 2,\n \"label\": \"High\"\n }\n ],\n \"cost_of_goods\": {\n \"amount\": 156.99,\n \"currency\": \"USD\"\n },\n \"assigned_user\": {\n \"value\": 42\n }\n },\n \"created_at\": \"2017-07-21T17:32:28Z\",\n \"updated_at\": \"2017-07-21T17:39:43Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{base_url_domain}/api/global/v1/shipping/retailers/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"code\": \"walmart\",\n \"name\": \"Walmart\",\n \"status\": \"active\",\n \"fulfillment_model\": \"wholesale\",\n \"merchant\": {\n \"code\": \"acme_inc\",\n \"name\": \"ACME Inc.\",\n \"custom_fields\": {\n \"is_gift\": {\n \"value\": true\n },\n \"order_details\": {\n \"value\": \"test details\"\n },\n \"department\": {\n \"id\": 3,\n \"label\": \"Shipping\"\n },\n \"priority_levels\": [\n {\n \"id\": 1,\n \"label\": \"Urgent\"\n },\n {\n \"id\": 2,\n \"label\": \"High\"\n }\n ],\n \"cost_of_goods\": {\n \"amount\": 156.99,\n \"currency\": \"USD\"\n },\n \"assigned_user\": {\n \"value\": 42\n }\n }\n },\n \"parent_retailer\": {\n \"type\": \"Retailer\",\n \"id\": 2\n },\n \"legal_name\": \"Walmart Inc.\",\n \"dba\": \"Walmart Marketplace\",\n \"default_duties_payor\": \"recipient\",\n \"default_shipping_method\": \"fedex_FEDEX_GROUND\",\n \"allowed_shipping_methods\": [\n \"fedex_FEDEX_GROUND\",\n \"ups_GND\"\n ],\n \"default_tpb_group_id\": 5,\n \"routing_guide_notes\": \"<string>\",\n \"custom_fields\": {\n \"is_gift\": {\n \"value\": true\n },\n \"order_details\": {\n \"value\": \"test details\"\n },\n \"department\": {\n \"id\": 3,\n \"label\": \"Shipping\"\n },\n \"priority_levels\": [\n {\n \"id\": 1,\n \"label\": \"Urgent\"\n },\n {\n \"id\": 2,\n \"label\": \"High\"\n }\n ],\n \"cost_of_goods\": {\n \"amount\": 156.99,\n \"currency\": \"USD\"\n },\n \"assigned_user\": {\n \"value\": 42\n }\n },\n \"created_at\": \"2017-07-21T17:32:28Z\",\n \"updated_at\": \"2017-07-21T17:39:43Z\"\n}"
response = http.request(request)
puts response.read_body{
"errors": [
{
"type": "parameters",
"message": "The supplied parameters are invalid.",
"details": [
{
"key": "hold_until_date",
"message": "The date must be in the future."
}
]
}
]
}{
"errors": [
{
"type": "not_found",
"message": "The server could not find the requested resource."
}
]
}{
"errors": [
{
"type": "unable_to_process",
"message": "The supplied parameters are invalid.",
"details": [
{
"key": "hold_until_date",
"message": "The date must be in the future."
}
]
}
]
}Retailers
Update Retailer
Updates a Retailer specified by its id path parameter and according to the request body.
PUT
/
v1
/
shipping
/
retailers
/
{id}
Update Retailer
curl --request PUT \
--url https://{base_url_domain}/api/global/v1/shipping/retailers/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"code": "walmart",
"name": "Walmart",
"status": "active",
"fulfillment_model": "wholesale",
"merchant": {
"code": "acme_inc",
"name": "ACME Inc.",
"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"
}
'import requests
url = "https://{base_url_domain}/api/global/v1/shipping/retailers/{id}"
payload = {
"code": "walmart",
"name": "Walmart",
"status": "active",
"fulfillment_model": "wholesale",
"merchant": {
"code": "acme_inc",
"name": "ACME Inc.",
"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"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
code: 'walmart',
name: 'Walmart',
status: 'active',
fulfillment_model: 'wholesale',
merchant: {
code: 'acme_inc',
name: 'ACME Inc.',
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'
})
};
fetch('https://{base_url_domain}/api/global/v1/shipping/retailers/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{base_url_domain}/api/global/v1/shipping/retailers/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'code' => 'walmart',
'name' => 'Walmart',
'status' => 'active',
'fulfillment_model' => 'wholesale',
'merchant' => [
'code' => 'acme_inc',
'name' => 'ACME Inc.',
'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'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{base_url_domain}/api/global/v1/shipping/retailers/{id}"
payload := strings.NewReader("{\n \"code\": \"walmart\",\n \"name\": \"Walmart\",\n \"status\": \"active\",\n \"fulfillment_model\": \"wholesale\",\n \"merchant\": {\n \"code\": \"acme_inc\",\n \"name\": \"ACME Inc.\",\n \"custom_fields\": {\n \"is_gift\": {\n \"value\": true\n },\n \"order_details\": {\n \"value\": \"test details\"\n },\n \"department\": {\n \"id\": 3,\n \"label\": \"Shipping\"\n },\n \"priority_levels\": [\n {\n \"id\": 1,\n \"label\": \"Urgent\"\n },\n {\n \"id\": 2,\n \"label\": \"High\"\n }\n ],\n \"cost_of_goods\": {\n \"amount\": 156.99,\n \"currency\": \"USD\"\n },\n \"assigned_user\": {\n \"value\": 42\n }\n }\n },\n \"parent_retailer\": {\n \"type\": \"Retailer\",\n \"id\": 2\n },\n \"legal_name\": \"Walmart Inc.\",\n \"dba\": \"Walmart Marketplace\",\n \"default_duties_payor\": \"recipient\",\n \"default_shipping_method\": \"fedex_FEDEX_GROUND\",\n \"allowed_shipping_methods\": [\n \"fedex_FEDEX_GROUND\",\n \"ups_GND\"\n ],\n \"default_tpb_group_id\": 5,\n \"routing_guide_notes\": \"<string>\",\n \"custom_fields\": {\n \"is_gift\": {\n \"value\": true\n },\n \"order_details\": {\n \"value\": \"test details\"\n },\n \"department\": {\n \"id\": 3,\n \"label\": \"Shipping\"\n },\n \"priority_levels\": [\n {\n \"id\": 1,\n \"label\": \"Urgent\"\n },\n {\n \"id\": 2,\n \"label\": \"High\"\n }\n ],\n \"cost_of_goods\": {\n \"amount\": 156.99,\n \"currency\": \"USD\"\n },\n \"assigned_user\": {\n \"value\": 42\n }\n },\n \"created_at\": \"2017-07-21T17:32:28Z\",\n \"updated_at\": \"2017-07-21T17:39:43Z\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://{base_url_domain}/api/global/v1/shipping/retailers/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"code\": \"walmart\",\n \"name\": \"Walmart\",\n \"status\": \"active\",\n \"fulfillment_model\": \"wholesale\",\n \"merchant\": {\n \"code\": \"acme_inc\",\n \"name\": \"ACME Inc.\",\n \"custom_fields\": {\n \"is_gift\": {\n \"value\": true\n },\n \"order_details\": {\n \"value\": \"test details\"\n },\n \"department\": {\n \"id\": 3,\n \"label\": \"Shipping\"\n },\n \"priority_levels\": [\n {\n \"id\": 1,\n \"label\": \"Urgent\"\n },\n {\n \"id\": 2,\n \"label\": \"High\"\n }\n ],\n \"cost_of_goods\": {\n \"amount\": 156.99,\n \"currency\": \"USD\"\n },\n \"assigned_user\": {\n \"value\": 42\n }\n }\n },\n \"parent_retailer\": {\n \"type\": \"Retailer\",\n \"id\": 2\n },\n \"legal_name\": \"Walmart Inc.\",\n \"dba\": \"Walmart Marketplace\",\n \"default_duties_payor\": \"recipient\",\n \"default_shipping_method\": \"fedex_FEDEX_GROUND\",\n \"allowed_shipping_methods\": [\n \"fedex_FEDEX_GROUND\",\n \"ups_GND\"\n ],\n \"default_tpb_group_id\": 5,\n \"routing_guide_notes\": \"<string>\",\n \"custom_fields\": {\n \"is_gift\": {\n \"value\": true\n },\n \"order_details\": {\n \"value\": \"test details\"\n },\n \"department\": {\n \"id\": 3,\n \"label\": \"Shipping\"\n },\n \"priority_levels\": [\n {\n \"id\": 1,\n \"label\": \"Urgent\"\n },\n {\n \"id\": 2,\n \"label\": \"High\"\n }\n ],\n \"cost_of_goods\": {\n \"amount\": 156.99,\n \"currency\": \"USD\"\n },\n \"assigned_user\": {\n \"value\": 42\n }\n },\n \"created_at\": \"2017-07-21T17:32:28Z\",\n \"updated_at\": \"2017-07-21T17:39:43Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{base_url_domain}/api/global/v1/shipping/retailers/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"code\": \"walmart\",\n \"name\": \"Walmart\",\n \"status\": \"active\",\n \"fulfillment_model\": \"wholesale\",\n \"merchant\": {\n \"code\": \"acme_inc\",\n \"name\": \"ACME Inc.\",\n \"custom_fields\": {\n \"is_gift\": {\n \"value\": true\n },\n \"order_details\": {\n \"value\": \"test details\"\n },\n \"department\": {\n \"id\": 3,\n \"label\": \"Shipping\"\n },\n \"priority_levels\": [\n {\n \"id\": 1,\n \"label\": \"Urgent\"\n },\n {\n \"id\": 2,\n \"label\": \"High\"\n }\n ],\n \"cost_of_goods\": {\n \"amount\": 156.99,\n \"currency\": \"USD\"\n },\n \"assigned_user\": {\n \"value\": 42\n }\n }\n },\n \"parent_retailer\": {\n \"type\": \"Retailer\",\n \"id\": 2\n },\n \"legal_name\": \"Walmart Inc.\",\n \"dba\": \"Walmart Marketplace\",\n \"default_duties_payor\": \"recipient\",\n \"default_shipping_method\": \"fedex_FEDEX_GROUND\",\n \"allowed_shipping_methods\": [\n \"fedex_FEDEX_GROUND\",\n \"ups_GND\"\n ],\n \"default_tpb_group_id\": 5,\n \"routing_guide_notes\": \"<string>\",\n \"custom_fields\": {\n \"is_gift\": {\n \"value\": true\n },\n \"order_details\": {\n \"value\": \"test details\"\n },\n \"department\": {\n \"id\": 3,\n \"label\": \"Shipping\"\n },\n \"priority_levels\": [\n {\n \"id\": 1,\n \"label\": \"Urgent\"\n },\n {\n \"id\": 2,\n \"label\": \"High\"\n }\n ],\n \"cost_of_goods\": {\n \"amount\": 156.99,\n \"currency\": \"USD\"\n },\n \"assigned_user\": {\n \"value\": 42\n }\n },\n \"created_at\": \"2017-07-21T17:32:28Z\",\n \"updated_at\": \"2017-07-21T17:39:43Z\"\n}"
response = http.request(request)
puts response.read_body{
"errors": [
{
"type": "parameters",
"message": "The supplied parameters are invalid.",
"details": [
{
"key": "hold_until_date",
"message": "The date must be in the future."
}
]
}
]
}{
"errors": [
{
"type": "not_found",
"message": "The server could not find the requested resource."
}
]
}{
"errors": [
{
"type": "unable_to_process",
"message": "The supplied parameters are invalid.",
"details": [
{
"key": "hold_until_date",
"message": "The date must be in the future."
}
]
}
]
}Authorizations
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
The id of the referenced Retailer.
Required range:
x >= 1Body
application/json
An object conforming to the Retailer schema to be merged with the existing Retailer.
A Retailer represents a B2B retail partner for a merchant, including fulfillment defaults and retailer-specific custom fields.
Unique retailer code within the merchant.
Required string length:
1 - 64Example:
"walmart"
Retailer display name.
Required string length:
1 - 255Example:
"Walmart"
Retailer lifecycle status.
Available options:
active, on_hold, terminated Example:
"active"
Default fulfillment model used for this retailer.
Available options:
wholesale, drop_ship, mixed Example:
"wholesale"
The merchant that owns this retailer.
Show child attributes
Show child attributes
Optional parent retailer reference. The parent must belong to the same merchant.
Optional Field
Show child attributes
Show child attributes
Legal retailer name.
Optional Field
Maximum string length:
255Example:
"Walmart Inc."
Doing-business-as name.
Optional Field
Maximum string length:
255Example:
"Walmart Marketplace"
Default duties payor for order-integration defaults.
Optional Field
Available options:
shipper, recipient, third_party Example:
"recipient"
Default shipping method for order-integration defaults.
Optional Field
Maximum string length:
255Example:
"fedex_FEDEX_GROUND"
Shipping methods allowed when this retailer is selected.
Optional Field
Example:
["fedex_FEDEX_GROUND", "ups_GND"]
Default shipping third-party billing group ID for order-integration defaults.
Optional Field
Required range:
x >= 1Example:
5
Free-form routing-guide notes.
Optional Field
Maximum string length:
65535Custom fields associated with the retailer in script format. Each field contains
a code and value, with additional properties depending on the field type.
Optional Field
Show child attributes
Show child attributes
Example:
{
"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 }
}
The date and time the retailer was created in RFC 3339 section 5.6 notation.
Optional Field
Example:
"2017-07-21T17:32:28Z"
The date and time the retailer was last updated in RFC 3339 section 5.6 notation.
Optional Field
Example:
"2017-07-21T17:39:43Z"
Response
OK - The operation completed successfully and there is no response body.
Was this page helpful?
⌘I