Create ship-to

curl --request POST \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-cart/ship-to/cart/{cartId} \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "shipToType": "SHIP_TO_ADDRESS",
  "shipMethod": {
    "shipMethodId": "1a2b3c4d5e6f7g8h9i0j",
    "cost": {
      "currency": "USD",
      "amount": 5.99
    },
    "shipmentCarrier": "Fedex",
    "shipmentMethod": "Next Day"
  },
  "address": {
    "street1": "123 Main Street",
    "city": "Seattle",
    "state": "WA",
    "country": "United States of America",
    "zipCode": "10008-1234",
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "email": "johnsmith@fabric.inc",
    "attention": "Leave at the back door.",
    "street2": "ABC Boulevard",
    "kind": "TBD"
  },
  "warehouseId": "123456abcdef123456abcdef",
  "isPickup": true,
  "taxCode": "FR1000",
  "storeId": "TBD",
  "pickupPerson": {
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "email": "johnsmith@fabric.inc"
  },
  "altPickupPerson": {
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "email": "johnsmith@fabric.inc"
  }
}
'

import requests

url = "https://prod01-apigw.{customer_name}.fabric.zone/api-cart/ship-to/cart/{cartId}"

payload = {
    "shipToType": "SHIP_TO_ADDRESS",
    "shipMethod": {
        "shipMethodId": "1a2b3c4d5e6f7g8h9i0j",
        "cost": {
            "currency": "USD",
            "amount": 5.99
        },
        "shipmentCarrier": "Fedex",
        "shipmentMethod": "Next Day"
    },
    "address": {
        "street1": "123 Main Street",
        "city": "Seattle",
        "state": "WA",
        "country": "United States of America",
        "zipCode": "10008-1234",
        "name": {
            "first": "John",
            "last": "Smith"
        },
        "email": "johnsmith@fabric.inc",
        "attention": "Leave at the back door.",
        "street2": "ABC Boulevard",
        "kind": "TBD"
    },
    "warehouseId": "123456abcdef123456abcdef",
    "isPickup": True,
    "taxCode": "FR1000",
    "storeId": "TBD",
    "pickupPerson": {
        "name": {
            "first": "John",
            "last": "Smith"
        },
        "email": "johnsmith@fabric.inc"
    },
    "altPickupPerson": {
        "name": {
            "first": "John",
            "last": "Smith"
        },
        "email": "johnsmith@fabric.inc"
    }
}
headers = {
    "x-site-context": "<x-site-context>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-site-context': '<x-site-context>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    shipToType: 'SHIP_TO_ADDRESS',
    shipMethod: {
      shipMethodId: '1a2b3c4d5e6f7g8h9i0j',
      cost: {currency: 'USD', amount: 5.99},
      shipmentCarrier: 'Fedex',
      shipmentMethod: 'Next Day'
    },
    address: {
      street1: '123 Main Street',
      city: 'Seattle',
      state: 'WA',
      country: 'United States of America',
      zipCode: '10008-1234',
      name: {first: 'John', last: 'Smith'},
      email: 'johnsmith@fabric.inc',
      attention: 'Leave at the back door.',
      street2: 'ABC Boulevard',
      kind: 'TBD'
    },
    warehouseId: '123456abcdef123456abcdef',
    isPickup: true,
    taxCode: 'FR1000',
    storeId: 'TBD',
    pickupPerson: {name: {first: 'John', last: 'Smith'}, email: 'johnsmith@fabric.inc'},
    altPickupPerson: {name: {first: 'John', last: 'Smith'}, email: 'johnsmith@fabric.inc'}
  })
};

fetch('https://prod01-apigw.{customer_name}.fabric.zone/api-cart/ship-to/cart/{cartId}', 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://prod01-apigw.{customer_name}.fabric.zone/api-cart/ship-to/cart/{cartId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'shipToType' => 'SHIP_TO_ADDRESS',
    'shipMethod' => [
        'shipMethodId' => '1a2b3c4d5e6f7g8h9i0j',
        'cost' => [
                'currency' => 'USD',
                'amount' => 5.99
        ],
        'shipmentCarrier' => 'Fedex',
        'shipmentMethod' => 'Next Day'
    ],
    'address' => [
        'street1' => '123 Main Street',
        'city' => 'Seattle',
        'state' => 'WA',
        'country' => 'United States of America',
        'zipCode' => '10008-1234',
        'name' => [
                'first' => 'John',
                'last' => 'Smith'
        ],
        'email' => 'johnsmith@fabric.inc',
        'attention' => 'Leave at the back door.',
        'street2' => 'ABC Boulevard',
        'kind' => 'TBD'
    ],
    'warehouseId' => '123456abcdef123456abcdef',
    'isPickup' => true,
    'taxCode' => 'FR1000',
    'storeId' => 'TBD',
    'pickupPerson' => [
        'name' => [
                'first' => 'John',
                'last' => 'Smith'
        ],
        'email' => 'johnsmith@fabric.inc'
    ],
    'altPickupPerson' => [
        'name' => [
                'first' => 'John',
                'last' => 'Smith'
        ],
        'email' => 'johnsmith@fabric.inc'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-site-context: <x-site-context>"
  ],
]);

$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://prod01-apigw.{customer_name}.fabric.zone/api-cart/ship-to/cart/{cartId}"

	payload := strings.NewReader("{\n  \"shipToType\": \"SHIP_TO_ADDRESS\",\n  \"shipMethod\": {\n    \"shipMethodId\": \"1a2b3c4d5e6f7g8h9i0j\",\n    \"cost\": {\n      \"currency\": \"USD\",\n      \"amount\": 5.99\n    },\n    \"shipmentCarrier\": \"Fedex\",\n    \"shipmentMethod\": \"Next Day\"\n  },\n  \"address\": {\n    \"street1\": \"123 Main Street\",\n    \"city\": \"Seattle\",\n    \"state\": \"WA\",\n    \"country\": \"United States of America\",\n    \"zipCode\": \"10008-1234\",\n    \"name\": {\n      \"first\": \"John\",\n      \"last\": \"Smith\"\n    },\n    \"email\": \"johnsmith@fabric.inc\",\n    \"attention\": \"Leave at the back door.\",\n    \"street2\": \"ABC Boulevard\",\n    \"kind\": \"TBD\"\n  },\n  \"warehouseId\": \"123456abcdef123456abcdef\",\n  \"isPickup\": true,\n  \"taxCode\": \"FR1000\",\n  \"storeId\": \"TBD\",\n  \"pickupPerson\": {\n    \"name\": {\n      \"first\": \"John\",\n      \"last\": \"Smith\"\n    },\n    \"email\": \"johnsmith@fabric.inc\"\n  },\n  \"altPickupPerson\": {\n    \"name\": {\n      \"first\": \"John\",\n      \"last\": \"Smith\"\n    },\n    \"email\": \"johnsmith@fabric.inc\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-site-context", "<x-site-context>")
	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.post("https://prod01-apigw.{customer_name}.fabric.zone/api-cart/ship-to/cart/{cartId}")
  .header("x-site-context", "<x-site-context>")
  .header("Content-Type", "application/json")
  .body("{\n  \"shipToType\": \"SHIP_TO_ADDRESS\",\n  \"shipMethod\": {\n    \"shipMethodId\": \"1a2b3c4d5e6f7g8h9i0j\",\n    \"cost\": {\n      \"currency\": \"USD\",\n      \"amount\": 5.99\n    },\n    \"shipmentCarrier\": \"Fedex\",\n    \"shipmentMethod\": \"Next Day\"\n  },\n  \"address\": {\n    \"street1\": \"123 Main Street\",\n    \"city\": \"Seattle\",\n    \"state\": \"WA\",\n    \"country\": \"United States of America\",\n    \"zipCode\": \"10008-1234\",\n    \"name\": {\n      \"first\": \"John\",\n      \"last\": \"Smith\"\n    },\n    \"email\": \"johnsmith@fabric.inc\",\n    \"attention\": \"Leave at the back door.\",\n    \"street2\": \"ABC Boulevard\",\n    \"kind\": \"TBD\"\n  },\n  \"warehouseId\": \"123456abcdef123456abcdef\",\n  \"isPickup\": true,\n  \"taxCode\": \"FR1000\",\n  \"storeId\": \"TBD\",\n  \"pickupPerson\": {\n    \"name\": {\n      \"first\": \"John\",\n      \"last\": \"Smith\"\n    },\n    \"email\": \"johnsmith@fabric.inc\"\n  },\n  \"altPickupPerson\": {\n    \"name\": {\n      \"first\": \"John\",\n      \"last\": \"Smith\"\n    },\n    \"email\": \"johnsmith@fabric.inc\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod01-apigw.{customer_name}.fabric.zone/api-cart/ship-to/cart/{cartId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-site-context"] = '<x-site-context>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"shipToType\": \"SHIP_TO_ADDRESS\",\n  \"shipMethod\": {\n    \"shipMethodId\": \"1a2b3c4d5e6f7g8h9i0j\",\n    \"cost\": {\n      \"currency\": \"USD\",\n      \"amount\": 5.99\n    },\n    \"shipmentCarrier\": \"Fedex\",\n    \"shipmentMethod\": \"Next Day\"\n  },\n  \"address\": {\n    \"street1\": \"123 Main Street\",\n    \"city\": \"Seattle\",\n    \"state\": \"WA\",\n    \"country\": \"United States of America\",\n    \"zipCode\": \"10008-1234\",\n    \"name\": {\n      \"first\": \"John\",\n      \"last\": \"Smith\"\n    },\n    \"email\": \"johnsmith@fabric.inc\",\n    \"attention\": \"Leave at the back door.\",\n    \"street2\": \"ABC Boulevard\",\n    \"kind\": \"TBD\"\n  },\n  \"warehouseId\": \"123456abcdef123456abcdef\",\n  \"isPickup\": true,\n  \"taxCode\": \"FR1000\",\n  \"storeId\": \"TBD\",\n  \"pickupPerson\": {\n    \"name\": {\n      \"first\": \"John\",\n      \"last\": \"Smith\"\n    },\n    \"email\": \"johnsmith@fabric.inc\"\n  },\n  \"altPickupPerson\": {\n    \"name\": {\n      \"first\": \"John\",\n      \"last\": \"Smith\"\n    },\n    \"email\": \"johnsmith@fabric.inc\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "shipToType": "SHIP_TO_ADDRESS",
  "warehouseId": "123456abcdef123456abcdef",
  "isPickup": true,
  "shipMethod": {
    "shipMethodId": "1a2b3c4d5e6f7g8h9i0j",
    "cost": {
      "currency": "USD",
      "amount": 5.99
    },
    "shipmentCarrier": "Fedex",
    "shipmentMethod": "Next Day"
  },
  "taxCode": "FR1000",
  "storeId": "TBD",
  "pickupPerson": {
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "phone": {
      "number": "123-456-7890",
      "kind": "Mobile"
    },
    "email": "johnsmith@fabric.inc"
  },
  "altPickupPerson": {
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "phone": {
      "number": "123-456-7890",
      "kind": "Mobile"
    },
    "email": "johnsmith@fabric.inc"
  },
  "address": {
    "attention": "Leave at the back door.",
    "street1": "123 Main Street",
    "street2": "ABC Boulevard",
    "city": "Seattle",
    "state": "WA",
    "country": "United States of America",
    "zipCode": "10008-1234",
    "kind": "TBD",
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "phone": {
      "number": "123-456-7890",
      "kind": "Mobile"
    },
    "email": "johnsmith@fabric.inc"
  },
  "cartId": "5e5818a84d030c206b2ffb02",
  "shipToId": 13812,
  "_id": "5fee9d59f2f08a1b3cbdea08",
  "createdAt": "2020-12-31T02:09:53.914Z",
  "updatedAt": "2020-12-31T02:09:53.914Z"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "CART_NOT_FOUND",
  "message": "Cart not found."
}

{
  "code": "<string>",
  "message": "<string>"
}

POST

api-cart

ship-to

cart

{cartId}

Create ship-to

curl --request POST \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-cart/ship-to/cart/{cartId} \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "shipToType": "SHIP_TO_ADDRESS",
  "shipMethod": {
    "shipMethodId": "1a2b3c4d5e6f7g8h9i0j",
    "cost": {
      "currency": "USD",
      "amount": 5.99
    },
    "shipmentCarrier": "Fedex",
    "shipmentMethod": "Next Day"
  },
  "address": {
    "street1": "123 Main Street",
    "city": "Seattle",
    "state": "WA",
    "country": "United States of America",
    "zipCode": "10008-1234",
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "email": "johnsmith@fabric.inc",
    "attention": "Leave at the back door.",
    "street2": "ABC Boulevard",
    "kind": "TBD"
  },
  "warehouseId": "123456abcdef123456abcdef",
  "isPickup": true,
  "taxCode": "FR1000",
  "storeId": "TBD",
  "pickupPerson": {
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "email": "johnsmith@fabric.inc"
  },
  "altPickupPerson": {
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "email": "johnsmith@fabric.inc"
  }
}
'

import requests

url = "https://prod01-apigw.{customer_name}.fabric.zone/api-cart/ship-to/cart/{cartId}"

payload = {
    "shipToType": "SHIP_TO_ADDRESS",
    "shipMethod": {
        "shipMethodId": "1a2b3c4d5e6f7g8h9i0j",
        "cost": {
            "currency": "USD",
            "amount": 5.99
        },
        "shipmentCarrier": "Fedex",
        "shipmentMethod": "Next Day"
    },
    "address": {
        "street1": "123 Main Street",
        "city": "Seattle",
        "state": "WA",
        "country": "United States of America",
        "zipCode": "10008-1234",
        "name": {
            "first": "John",
            "last": "Smith"
        },
        "email": "johnsmith@fabric.inc",
        "attention": "Leave at the back door.",
        "street2": "ABC Boulevard",
        "kind": "TBD"
    },
    "warehouseId": "123456abcdef123456abcdef",
    "isPickup": True,
    "taxCode": "FR1000",
    "storeId": "TBD",
    "pickupPerson": {
        "name": {
            "first": "John",
            "last": "Smith"
        },
        "email": "johnsmith@fabric.inc"
    },
    "altPickupPerson": {
        "name": {
            "first": "John",
            "last": "Smith"
        },
        "email": "johnsmith@fabric.inc"
    }
}
headers = {
    "x-site-context": "<x-site-context>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-site-context': '<x-site-context>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    shipToType: 'SHIP_TO_ADDRESS',
    shipMethod: {
      shipMethodId: '1a2b3c4d5e6f7g8h9i0j',
      cost: {currency: 'USD', amount: 5.99},
      shipmentCarrier: 'Fedex',
      shipmentMethod: 'Next Day'
    },
    address: {
      street1: '123 Main Street',
      city: 'Seattle',
      state: 'WA',
      country: 'United States of America',
      zipCode: '10008-1234',
      name: {first: 'John', last: 'Smith'},
      email: 'johnsmith@fabric.inc',
      attention: 'Leave at the back door.',
      street2: 'ABC Boulevard',
      kind: 'TBD'
    },
    warehouseId: '123456abcdef123456abcdef',
    isPickup: true,
    taxCode: 'FR1000',
    storeId: 'TBD',
    pickupPerson: {name: {first: 'John', last: 'Smith'}, email: 'johnsmith@fabric.inc'},
    altPickupPerson: {name: {first: 'John', last: 'Smith'}, email: 'johnsmith@fabric.inc'}
  })
};

fetch('https://prod01-apigw.{customer_name}.fabric.zone/api-cart/ship-to/cart/{cartId}', 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://prod01-apigw.{customer_name}.fabric.zone/api-cart/ship-to/cart/{cartId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'shipToType' => 'SHIP_TO_ADDRESS',
    'shipMethod' => [
        'shipMethodId' => '1a2b3c4d5e6f7g8h9i0j',
        'cost' => [
                'currency' => 'USD',
                'amount' => 5.99
        ],
        'shipmentCarrier' => 'Fedex',
        'shipmentMethod' => 'Next Day'
    ],
    'address' => [
        'street1' => '123 Main Street',
        'city' => 'Seattle',
        'state' => 'WA',
        'country' => 'United States of America',
        'zipCode' => '10008-1234',
        'name' => [
                'first' => 'John',
                'last' => 'Smith'
        ],
        'email' => 'johnsmith@fabric.inc',
        'attention' => 'Leave at the back door.',
        'street2' => 'ABC Boulevard',
        'kind' => 'TBD'
    ],
    'warehouseId' => '123456abcdef123456abcdef',
    'isPickup' => true,
    'taxCode' => 'FR1000',
    'storeId' => 'TBD',
    'pickupPerson' => [
        'name' => [
                'first' => 'John',
                'last' => 'Smith'
        ],
        'email' => 'johnsmith@fabric.inc'
    ],
    'altPickupPerson' => [
        'name' => [
                'first' => 'John',
                'last' => 'Smith'
        ],
        'email' => 'johnsmith@fabric.inc'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-site-context: <x-site-context>"
  ],
]);

$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://prod01-apigw.{customer_name}.fabric.zone/api-cart/ship-to/cart/{cartId}"

	payload := strings.NewReader("{\n  \"shipToType\": \"SHIP_TO_ADDRESS\",\n  \"shipMethod\": {\n    \"shipMethodId\": \"1a2b3c4d5e6f7g8h9i0j\",\n    \"cost\": {\n      \"currency\": \"USD\",\n      \"amount\": 5.99\n    },\n    \"shipmentCarrier\": \"Fedex\",\n    \"shipmentMethod\": \"Next Day\"\n  },\n  \"address\": {\n    \"street1\": \"123 Main Street\",\n    \"city\": \"Seattle\",\n    \"state\": \"WA\",\n    \"country\": \"United States of America\",\n    \"zipCode\": \"10008-1234\",\n    \"name\": {\n      \"first\": \"John\",\n      \"last\": \"Smith\"\n    },\n    \"email\": \"johnsmith@fabric.inc\",\n    \"attention\": \"Leave at the back door.\",\n    \"street2\": \"ABC Boulevard\",\n    \"kind\": \"TBD\"\n  },\n  \"warehouseId\": \"123456abcdef123456abcdef\",\n  \"isPickup\": true,\n  \"taxCode\": \"FR1000\",\n  \"storeId\": \"TBD\",\n  \"pickupPerson\": {\n    \"name\": {\n      \"first\": \"John\",\n      \"last\": \"Smith\"\n    },\n    \"email\": \"johnsmith@fabric.inc\"\n  },\n  \"altPickupPerson\": {\n    \"name\": {\n      \"first\": \"John\",\n      \"last\": \"Smith\"\n    },\n    \"email\": \"johnsmith@fabric.inc\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-site-context", "<x-site-context>")
	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.post("https://prod01-apigw.{customer_name}.fabric.zone/api-cart/ship-to/cart/{cartId}")
  .header("x-site-context", "<x-site-context>")
  .header("Content-Type", "application/json")
  .body("{\n  \"shipToType\": \"SHIP_TO_ADDRESS\",\n  \"shipMethod\": {\n    \"shipMethodId\": \"1a2b3c4d5e6f7g8h9i0j\",\n    \"cost\": {\n      \"currency\": \"USD\",\n      \"amount\": 5.99\n    },\n    \"shipmentCarrier\": \"Fedex\",\n    \"shipmentMethod\": \"Next Day\"\n  },\n  \"address\": {\n    \"street1\": \"123 Main Street\",\n    \"city\": \"Seattle\",\n    \"state\": \"WA\",\n    \"country\": \"United States of America\",\n    \"zipCode\": \"10008-1234\",\n    \"name\": {\n      \"first\": \"John\",\n      \"last\": \"Smith\"\n    },\n    \"email\": \"johnsmith@fabric.inc\",\n    \"attention\": \"Leave at the back door.\",\n    \"street2\": \"ABC Boulevard\",\n    \"kind\": \"TBD\"\n  },\n  \"warehouseId\": \"123456abcdef123456abcdef\",\n  \"isPickup\": true,\n  \"taxCode\": \"FR1000\",\n  \"storeId\": \"TBD\",\n  \"pickupPerson\": {\n    \"name\": {\n      \"first\": \"John\",\n      \"last\": \"Smith\"\n    },\n    \"email\": \"johnsmith@fabric.inc\"\n  },\n  \"altPickupPerson\": {\n    \"name\": {\n      \"first\": \"John\",\n      \"last\": \"Smith\"\n    },\n    \"email\": \"johnsmith@fabric.inc\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod01-apigw.{customer_name}.fabric.zone/api-cart/ship-to/cart/{cartId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-site-context"] = '<x-site-context>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"shipToType\": \"SHIP_TO_ADDRESS\",\n  \"shipMethod\": {\n    \"shipMethodId\": \"1a2b3c4d5e6f7g8h9i0j\",\n    \"cost\": {\n      \"currency\": \"USD\",\n      \"amount\": 5.99\n    },\n    \"shipmentCarrier\": \"Fedex\",\n    \"shipmentMethod\": \"Next Day\"\n  },\n  \"address\": {\n    \"street1\": \"123 Main Street\",\n    \"city\": \"Seattle\",\n    \"state\": \"WA\",\n    \"country\": \"United States of America\",\n    \"zipCode\": \"10008-1234\",\n    \"name\": {\n      \"first\": \"John\",\n      \"last\": \"Smith\"\n    },\n    \"email\": \"johnsmith@fabric.inc\",\n    \"attention\": \"Leave at the back door.\",\n    \"street2\": \"ABC Boulevard\",\n    \"kind\": \"TBD\"\n  },\n  \"warehouseId\": \"123456abcdef123456abcdef\",\n  \"isPickup\": true,\n  \"taxCode\": \"FR1000\",\n  \"storeId\": \"TBD\",\n  \"pickupPerson\": {\n    \"name\": {\n      \"first\": \"John\",\n      \"last\": \"Smith\"\n    },\n    \"email\": \"johnsmith@fabric.inc\"\n  },\n  \"altPickupPerson\": {\n    \"name\": {\n      \"first\": \"John\",\n      \"last\": \"Smith\"\n    },\n    \"email\": \"johnsmith@fabric.inc\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "shipToType": "SHIP_TO_ADDRESS",
  "warehouseId": "123456abcdef123456abcdef",
  "isPickup": true,
  "shipMethod": {
    "shipMethodId": "1a2b3c4d5e6f7g8h9i0j",
    "cost": {
      "currency": "USD",
      "amount": 5.99
    },
    "shipmentCarrier": "Fedex",
    "shipmentMethod": "Next Day"
  },
  "taxCode": "FR1000",
  "storeId": "TBD",
  "pickupPerson": {
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "phone": {
      "number": "123-456-7890",
      "kind": "Mobile"
    },
    "email": "johnsmith@fabric.inc"
  },
  "altPickupPerson": {
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "phone": {
      "number": "123-456-7890",
      "kind": "Mobile"
    },
    "email": "johnsmith@fabric.inc"
  },
  "address": {
    "attention": "Leave at the back door.",
    "street1": "123 Main Street",
    "street2": "ABC Boulevard",
    "city": "Seattle",
    "state": "WA",
    "country": "United States of America",
    "zipCode": "10008-1234",
    "kind": "TBD",
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "phone": {
      "number": "123-456-7890",
      "kind": "Mobile"
    },
    "email": "johnsmith@fabric.inc"
  },
  "cartId": "5e5818a84d030c206b2ffb02",
  "shipToId": 13812,
  "_id": "5fee9d59f2f08a1b3cbdea08",
  "createdAt": "2020-12-31T02:09:53.914Z",
  "updatedAt": "2020-12-31T02:09:53.914Z"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "CART_NOT_FOUND",
  "message": "Cart not found."
}

{
  "code": "<string>",
  "message": "<string>"
}

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

cartId

string

required

Required string length: 24

Example:

"5e5818a84d030c206b2ffb02"

Body

application/json

shipToType

enum<string>

required

Available options:

BOPIS,

SHIP_TO_STORE,

SHIP_TO_ADDRESS,

STORE_PICKUP

Example:

"SHIP_TO_ADDRESS"

shipMethod

object

required

Show child attributes

address

object

required

Show child attributes

warehouseId

string

Required string length: 24

Example:

"123456abcdef123456abcdef"

isPickup

boolean

Example:

true

taxCode

string

Example:

"FR1000"

storeId

string

Required string length: 5 - 50

Example:

"TBD"

pickupPerson

object

Show child attributes

altPickupPerson

object

Show child attributes

Response

Ship To Created

shipToType

enum<string>

Available options:

BOPIS,

SHIP_TO_STORE,

SHIP_TO_ADDRESS,

STORE_PICKUP

Example:

"SHIP_TO_ADDRESS"

warehouseId

string

Required string length: 24

Example:

"123456abcdef123456abcdef"

isPickup

boolean

Example:

true

shipMethod

object

Show child attributes

taxCode

string

Example:

"FR1000"

storeId

string

Required string length: 5 - 50

Example:

"TBD"

pickupPerson

object

Show child attributes

altPickupPerson

object

Show child attributes

address

object

Show child attributes

cartId

string

Required string length: 24

Example:

"5e5818a84d030c206b2ffb02"

shipToId

number

Example:

13812

_id

string

Example:

"5fee9d59f2f08a1b3cbdea08"

createdAt

string

Example:

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

updatedAt

string

Example:

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

Overview Create ship-to (v1)

⌘I

Authentication v1

User Self Service APIs

Experiences v2 (XM v2)

Experiences v1 (XM v1)

Product Catalog

Orders v2 (OMS v2)

Orders v1 (OMS v1)

Offers v2

Offers v1

Subscriptions (SMT API)

Loyalty (Member)

Dropship

Cart API

Checkout API

Customer

Create ship-to

Headers

Path Parameters

Body

Response