Skip to main content
POST
/
v1
/
receiving
/
manifest
/
{manifestId}
/
items
/
{itemId}
/
receive
Receive a manifest item
curl --request POST \
  --url http://localhost:3000/v1/receiving/manifest/{manifestId}/items/{itemId}/receive \
  --header 'Content-Type: application/json' \
  --data '
{
  "quantity": 1,
  "cart_id": "<string>"
}
'
import requests

url = "http://localhost:3000/v1/receiving/manifest/{manifestId}/items/{itemId}/receive"

payload = {
    "quantity": 1,
    "cart_id": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({quantity: 1, cart_id: '<string>'})
};

fetch('http://localhost:3000/v1/receiving/manifest/{manifestId}/items/{itemId}/receive', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/v1/receiving/manifest/{manifestId}/items/{itemId}/receive",
  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([
    'quantity' => 1,
    'cart_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "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 := "http://localhost:3000/v1/receiving/manifest/{manifestId}/items/{itemId}/receive"

	payload := strings.NewReader("{\n  \"quantity\": 1,\n  \"cart_id\": \"<string>\"\n}")

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

	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("http://localhost:3000/v1/receiving/manifest/{manifestId}/items/{itemId}/receive")
  .header("Content-Type", "application/json")
  .body("{\n  \"quantity\": 1,\n  \"cart_id\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/v1/receiving/manifest/{manifestId}/items/{itemId}/receive")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"quantity\": 1,\n  \"cart_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "item": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "received_quantity": 123,
    "expected_quantity": 123,
    "fully_received": true
  },
  "manifest": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "<string>",
    "fully_received": true,
    "total_expected_quantity": 123,
    "total_received_quantity": 123
  },
  "assigned_cart": {
    "id": "<string>",
    "label": "<string>",
    "display_id": "<string>"
  }
}
{
  "error": "<string>"
}
{
  "error": "<string>"
}
{
  "error": "<string>"
}

Path Parameters

manifestId
string<uuid>
required

Manifest UUID

itemId
string<uuid>
required

Manifest item UUID

Body

application/json
quantity
integer

Quantity to receive. Defaults to 1.

Required range: x > 0
cart_id
string

Stocking cart taxonomy ID to place item in

Response

Item received successfully

success
boolean
required
item
object
required
manifest
object
required
assigned_cart
object