Add items to shipping methods

curl --request POST \
  --url https://prod01.oms.fabric.inc/api/v2/shipping/{shipMethodId}/item \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "itemIds": [
    "234553",
    "12345"
  ]
}
'

import requests

url = "https://prod01.oms.fabric.inc/api/v2/shipping/{shipMethodId}/item"

payload = { "itemIds": ["234553", "12345"] }
headers = {
    "x-site-context": "<x-site-context>",
    "Authorization": "Bearer <token>",
    "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>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({itemIds: ['234553', '12345']})
};

fetch('https://prod01.oms.fabric.inc/api/v2/shipping/{shipMethodId}/item', 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.oms.fabric.inc/api/v2/shipping/{shipMethodId}/item",
  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([
    'itemIds' => [
        '234553',
        '12345'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.oms.fabric.inc/api/v2/shipping/{shipMethodId}/item"

	payload := strings.NewReader("{\n  \"itemIds\": [\n    \"234553\",\n    \"12345\"\n  ]\n}")

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

	req.Header.Add("x-site-context", "<x-site-context>")
	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.post("https://prod01.oms.fabric.inc/api/v2/shipping/{shipMethodId}/item")
  .header("x-site-context", "<x-site-context>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"itemIds\": [\n    \"234553\",\n    \"12345\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod01.oms.fabric.inc/api/v2/shipping/{shipMethodId}/item")

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["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"itemIds\": [\n    \"234553\",\n    \"12345\"\n  ]\n}"

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

[
  {
    "shippingMethodId": "5349b4ddd2781d08c09890f4",
    "itemId": "1234",
    "deleted": false
  }
]

{
  "message": "Bad Request"
}

{
  "message": "<string>"
}

{
  "message": "Internal Server Error"
}

POST

shipping

{shipMethodId}

item

Add items to shipping methods

curl --request POST \
  --url https://prod01.oms.fabric.inc/api/v2/shipping/{shipMethodId}/item \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "itemIds": [
    "234553",
    "12345"
  ]
}
'

import requests

url = "https://prod01.oms.fabric.inc/api/v2/shipping/{shipMethodId}/item"

payload = { "itemIds": ["234553", "12345"] }
headers = {
    "x-site-context": "<x-site-context>",
    "Authorization": "Bearer <token>",
    "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>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({itemIds: ['234553', '12345']})
};

fetch('https://prod01.oms.fabric.inc/api/v2/shipping/{shipMethodId}/item', 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.oms.fabric.inc/api/v2/shipping/{shipMethodId}/item",
  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([
    'itemIds' => [
        '234553',
        '12345'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.oms.fabric.inc/api/v2/shipping/{shipMethodId}/item"

	payload := strings.NewReader("{\n  \"itemIds\": [\n    \"234553\",\n    \"12345\"\n  ]\n}")

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

	req.Header.Add("x-site-context", "<x-site-context>")
	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.post("https://prod01.oms.fabric.inc/api/v2/shipping/{shipMethodId}/item")
  .header("x-site-context", "<x-site-context>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"itemIds\": [\n    \"234553\",\n    \"12345\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod01.oms.fabric.inc/api/v2/shipping/{shipMethodId}/item")

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["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"itemIds\": [\n    \"234553\",\n    \"12345\"\n  ]\n}"

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

[
  {
    "shippingMethodId": "5349b4ddd2781d08c09890f4",
    "itemId": "1234",
    "deleted": false
  }
]

{
  "message": "Bad Request"
}

{
  "message": "<string>"
}

{
  "message": "Internal Server Error"
}

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 for shipping method

Body

application/json

List of item IDs

itemIds

string[]

required

List of item IDs

Example:

["234553", "12345"]

Response

shippingMethodId

string

required

24-character system-generated shipping method ID

Example:

"5349b4ddd2781d08c09890f4"

itemId

string

required

Item ID

Example:

"1234"

deleted

boolean

true: Item is deleted
false: Item is not deleted

Example:

false

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

Add items to shipping methods

Authorizations

Headers

Path Parameters

Body

Response