Add items to a specific list

Add array of items to a specific list by list ID.

POST /list/{listId}/items

Add items to a specific list

cURL

curl --request POST \
  --url https://prod01.oms.fabric.inc/api/v2/list/{listId}/items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "sku": "sku1",
    "itemId": "123",
    "quantity": 1
  }
]
'

import requests

url = "https://prod01.oms.fabric.inc/api/v2/list/{listId}/items"

payload = [
    {
        "sku": "sku1",
        "itemId": "123",
        "quantity": 1
    }
]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([{sku: 'sku1', itemId: '123', quantity: 1}])
};

fetch('https://prod01.oms.fabric.inc/api/v2/list/{listId}/items', 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/list/{listId}/items",
  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([
    [
        'sku' => 'sku1',
        'itemId' => '123',
        'quantity' => 1
    ]
  ]),
  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://prod01.oms.fabric.inc/api/v2/list/{listId}/items"

	payload := strings.NewReader("[\n  {\n    \"sku\": \"sku1\",\n    \"itemId\": \"123\",\n    \"quantity\": 1\n  }\n]")

	req, _ := http.NewRequest("POST", 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.post("https://prod01.oms.fabric.inc/api/v2/list/{listId}/items")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"sku\": \"sku1\",\n    \"itemId\": \"123\",\n    \"quantity\": 1\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod01.oms.fabric.inc/api/v2/list/{listId}/items")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"sku\": \"sku1\",\n    \"itemId\": \"123\",\n    \"quantity\": 1\n  }\n]"

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

200

[
  {
    "listId": "5349b4ddd2781d08c09890f4",
    "sku": "sku1",
    "itemId": "123",
    "quantity": 1
  }
]

{
  "message": "Bad Request"
}

{
  "message": "Object Not Found."
}

{
  "message": "Internal Server Error"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

listId · string · required

ID of the list to which items are to be added

Example:

"62fa3796841ea417fa71d2a9"

Body

application/json

sku · string

SKU

Example:

"sku1"

itemId · string

Id of the item to be added to the list

Example:

"123"

quantity · integer<int32>

Number of items added to the list

Example:

1

Response

200

application/json

ListDetails Created

listId · string · required

ID of the list to which the item is added

Example:

"5349b4ddd2781d08c09890f4"

sku · string

SKU

Example:

"sku1"

itemId · string

Id of the item to be added to the list

Example:

"123"

quantity · integer<int32>

Number of items added to the list

Required range: x >= 0

Example:

1