curl --request POST \
--url https://api.decodahealth.com/inventory/shipments/create \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
[
{
"stockId": "<string>",
"supplierId": "<string>",
"locationId": "<string>",
"quantity": 123,
"remainingQuantity": 123,
"id": "<string>",
"lotNumber": "<string>",
"expiryDate": "2023-11-07T05:31:56Z",
"sku": "<string>",
"cost": 123,
"supplier": {
"name": "<string>",
"id": "<string>",
"description": "<string>",
"website": "<string>",
"email": "<string>",
"preferredContactMethod": "<string>",
"phoneNumber": "<string>",
"addressLineOne": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"isArchived": false
},
"createdDate": "2023-11-07T05:31:56Z",
"note": "<string>"
}
]
'import requests
url = "https://api.decodahealth.com/inventory/shipments/create"
payload = [
{
"stockId": "<string>",
"supplierId": "<string>",
"locationId": "<string>",
"quantity": 123,
"remainingQuantity": 123,
"id": "<string>",
"lotNumber": "<string>",
"expiryDate": "2023-11-07T05:31:56Z",
"sku": "<string>",
"cost": 123,
"supplier": {
"name": "<string>",
"id": "<string>",
"description": "<string>",
"website": "<string>",
"email": "<string>",
"preferredContactMethod": "<string>",
"phoneNumber": "<string>",
"addressLineOne": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"isArchived": False
},
"createdDate": "2023-11-07T05:31:56Z",
"note": "<string>"
}
]
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
stockId: '<string>',
supplierId: '<string>',
locationId: '<string>',
quantity: 123,
remainingQuantity: 123,
id: '<string>',
lotNumber: '<string>',
expiryDate: '2023-11-07T05:31:56Z',
sku: '<string>',
cost: 123,
supplier: {
name: '<string>',
id: '<string>',
description: '<string>',
website: '<string>',
email: '<string>',
preferredContactMethod: '<string>',
phoneNumber: '<string>',
addressLineOne: '<string>',
addressLineTwo: '<string>',
city: '<string>',
state: '<string>',
zipCode: '<string>',
country: '<string>',
isArchived: false
},
createdDate: '2023-11-07T05:31:56Z',
note: '<string>'
}
])
};
fetch('https://api.decodahealth.com/inventory/shipments/create', 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://api.decodahealth.com/inventory/shipments/create",
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([
[
'stockId' => '<string>',
'supplierId' => '<string>',
'locationId' => '<string>',
'quantity' => 123,
'remainingQuantity' => 123,
'id' => '<string>',
'lotNumber' => '<string>',
'expiryDate' => '2023-11-07T05:31:56Z',
'sku' => '<string>',
'cost' => 123,
'supplier' => [
'name' => '<string>',
'id' => '<string>',
'description' => '<string>',
'website' => '<string>',
'email' => '<string>',
'preferredContactMethod' => '<string>',
'phoneNumber' => '<string>',
'addressLineOne' => '<string>',
'addressLineTwo' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zipCode' => '<string>',
'country' => '<string>',
'isArchived' => false
],
'createdDate' => '2023-11-07T05:31:56Z',
'note' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json",
"TENANT: <tenant>"
],
]);
$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://api.decodahealth.com/inventory/shipments/create"
payload := strings.NewReader("[\n {\n \"stockId\": \"<string>\",\n \"supplierId\": \"<string>\",\n \"locationId\": \"<string>\",\n \"quantity\": 123,\n \"remainingQuantity\": 123,\n \"id\": \"<string>\",\n \"lotNumber\": \"<string>\",\n \"expiryDate\": \"2023-11-07T05:31:56Z\",\n \"sku\": \"<string>\",\n \"cost\": 123,\n \"supplier\": {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"website\": \"<string>\",\n \"email\": \"<string>\",\n \"preferredContactMethod\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"addressLineOne\": \"<string>\",\n \"addressLineTwo\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"country\": \"<string>\",\n \"isArchived\": false\n },\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"note\": \"<string>\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-KEY", "<api-key>")
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://api.decodahealth.com/inventory/shipments/create")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("[\n {\n \"stockId\": \"<string>\",\n \"supplierId\": \"<string>\",\n \"locationId\": \"<string>\",\n \"quantity\": 123,\n \"remainingQuantity\": 123,\n \"id\": \"<string>\",\n \"lotNumber\": \"<string>\",\n \"expiryDate\": \"2023-11-07T05:31:56Z\",\n \"sku\": \"<string>\",\n \"cost\": 123,\n \"supplier\": {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"website\": \"<string>\",\n \"email\": \"<string>\",\n \"preferredContactMethod\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"addressLineOne\": \"<string>\",\n \"addressLineTwo\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"country\": \"<string>\",\n \"isArchived\": false\n },\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"note\": \"<string>\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/inventory/shipments/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"stockId\": \"<string>\",\n \"supplierId\": \"<string>\",\n \"locationId\": \"<string>\",\n \"quantity\": 123,\n \"remainingQuantity\": 123,\n \"id\": \"<string>\",\n \"lotNumber\": \"<string>\",\n \"expiryDate\": \"2023-11-07T05:31:56Z\",\n \"sku\": \"<string>\",\n \"cost\": 123,\n \"supplier\": {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"website\": \"<string>\",\n \"email\": \"<string>\",\n \"preferredContactMethod\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"addressLineOne\": \"<string>\",\n \"addressLineTwo\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"country\": \"<string>\",\n \"isArchived\": false\n },\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"note\": \"<string>\"\n }\n]"
response = http.request(request)
puts response.read_body[
{
"stockId": "<string>",
"supplierId": "<string>",
"locationId": "<string>",
"quantity": 123,
"remainingQuantity": 123,
"locationName": "<string>",
"id": "<string>",
"lotNumber": "<string>",
"expiryDate": "2023-11-07T05:31:56Z",
"sku": "<string>",
"cost": 123,
"supplier": {
"name": "<string>",
"id": "<string>",
"description": "<string>",
"website": "<string>",
"email": "<string>",
"preferredContactMethod": "<string>",
"phoneNumber": "<string>",
"addressLineOne": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"isArchived": false
},
"createdDate": "2023-11-07T05:31:56Z",
"note": "<string>"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Create Shipments
Create new shipments.
curl --request POST \
--url https://api.decodahealth.com/inventory/shipments/create \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
[
{
"stockId": "<string>",
"supplierId": "<string>",
"locationId": "<string>",
"quantity": 123,
"remainingQuantity": 123,
"id": "<string>",
"lotNumber": "<string>",
"expiryDate": "2023-11-07T05:31:56Z",
"sku": "<string>",
"cost": 123,
"supplier": {
"name": "<string>",
"id": "<string>",
"description": "<string>",
"website": "<string>",
"email": "<string>",
"preferredContactMethod": "<string>",
"phoneNumber": "<string>",
"addressLineOne": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"isArchived": false
},
"createdDate": "2023-11-07T05:31:56Z",
"note": "<string>"
}
]
'import requests
url = "https://api.decodahealth.com/inventory/shipments/create"
payload = [
{
"stockId": "<string>",
"supplierId": "<string>",
"locationId": "<string>",
"quantity": 123,
"remainingQuantity": 123,
"id": "<string>",
"lotNumber": "<string>",
"expiryDate": "2023-11-07T05:31:56Z",
"sku": "<string>",
"cost": 123,
"supplier": {
"name": "<string>",
"id": "<string>",
"description": "<string>",
"website": "<string>",
"email": "<string>",
"preferredContactMethod": "<string>",
"phoneNumber": "<string>",
"addressLineOne": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"isArchived": False
},
"createdDate": "2023-11-07T05:31:56Z",
"note": "<string>"
}
]
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
stockId: '<string>',
supplierId: '<string>',
locationId: '<string>',
quantity: 123,
remainingQuantity: 123,
id: '<string>',
lotNumber: '<string>',
expiryDate: '2023-11-07T05:31:56Z',
sku: '<string>',
cost: 123,
supplier: {
name: '<string>',
id: '<string>',
description: '<string>',
website: '<string>',
email: '<string>',
preferredContactMethod: '<string>',
phoneNumber: '<string>',
addressLineOne: '<string>',
addressLineTwo: '<string>',
city: '<string>',
state: '<string>',
zipCode: '<string>',
country: '<string>',
isArchived: false
},
createdDate: '2023-11-07T05:31:56Z',
note: '<string>'
}
])
};
fetch('https://api.decodahealth.com/inventory/shipments/create', 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://api.decodahealth.com/inventory/shipments/create",
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([
[
'stockId' => '<string>',
'supplierId' => '<string>',
'locationId' => '<string>',
'quantity' => 123,
'remainingQuantity' => 123,
'id' => '<string>',
'lotNumber' => '<string>',
'expiryDate' => '2023-11-07T05:31:56Z',
'sku' => '<string>',
'cost' => 123,
'supplier' => [
'name' => '<string>',
'id' => '<string>',
'description' => '<string>',
'website' => '<string>',
'email' => '<string>',
'preferredContactMethod' => '<string>',
'phoneNumber' => '<string>',
'addressLineOne' => '<string>',
'addressLineTwo' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zipCode' => '<string>',
'country' => '<string>',
'isArchived' => false
],
'createdDate' => '2023-11-07T05:31:56Z',
'note' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json",
"TENANT: <tenant>"
],
]);
$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://api.decodahealth.com/inventory/shipments/create"
payload := strings.NewReader("[\n {\n \"stockId\": \"<string>\",\n \"supplierId\": \"<string>\",\n \"locationId\": \"<string>\",\n \"quantity\": 123,\n \"remainingQuantity\": 123,\n \"id\": \"<string>\",\n \"lotNumber\": \"<string>\",\n \"expiryDate\": \"2023-11-07T05:31:56Z\",\n \"sku\": \"<string>\",\n \"cost\": 123,\n \"supplier\": {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"website\": \"<string>\",\n \"email\": \"<string>\",\n \"preferredContactMethod\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"addressLineOne\": \"<string>\",\n \"addressLineTwo\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"country\": \"<string>\",\n \"isArchived\": false\n },\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"note\": \"<string>\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-KEY", "<api-key>")
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://api.decodahealth.com/inventory/shipments/create")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("[\n {\n \"stockId\": \"<string>\",\n \"supplierId\": \"<string>\",\n \"locationId\": \"<string>\",\n \"quantity\": 123,\n \"remainingQuantity\": 123,\n \"id\": \"<string>\",\n \"lotNumber\": \"<string>\",\n \"expiryDate\": \"2023-11-07T05:31:56Z\",\n \"sku\": \"<string>\",\n \"cost\": 123,\n \"supplier\": {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"website\": \"<string>\",\n \"email\": \"<string>\",\n \"preferredContactMethod\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"addressLineOne\": \"<string>\",\n \"addressLineTwo\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"country\": \"<string>\",\n \"isArchived\": false\n },\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"note\": \"<string>\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/inventory/shipments/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"stockId\": \"<string>\",\n \"supplierId\": \"<string>\",\n \"locationId\": \"<string>\",\n \"quantity\": 123,\n \"remainingQuantity\": 123,\n \"id\": \"<string>\",\n \"lotNumber\": \"<string>\",\n \"expiryDate\": \"2023-11-07T05:31:56Z\",\n \"sku\": \"<string>\",\n \"cost\": 123,\n \"supplier\": {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"website\": \"<string>\",\n \"email\": \"<string>\",\n \"preferredContactMethod\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"addressLineOne\": \"<string>\",\n \"addressLineTwo\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"country\": \"<string>\",\n \"isArchived\": false\n },\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"note\": \"<string>\"\n }\n]"
response = http.request(request)
puts response.read_body[
{
"stockId": "<string>",
"supplierId": "<string>",
"locationId": "<string>",
"quantity": 123,
"remainingQuantity": 123,
"locationName": "<string>",
"id": "<string>",
"lotNumber": "<string>",
"expiryDate": "2023-11-07T05:31:56Z",
"sku": "<string>",
"cost": 123,
"supplier": {
"name": "<string>",
"id": "<string>",
"description": "<string>",
"website": "<string>",
"email": "<string>",
"preferredContactMethod": "<string>",
"phoneNumber": "<string>",
"addressLineOne": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"isArchived": false
},
"createdDate": "2023-11-07T05:31:56Z",
"note": "<string>"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Headers
The tenant you are making this request on behalf of
Your api key
Body
ID of the stock
ID of the supplier
ID of the location where the shipment was delivered
Total quantity
Remaining quantity
Unique identifier for the shipment
Optional lot number of the shipment
Optional expiry date of the shipment
Optional SKU (Stock Keeping Unit)
Cost of the shipment in cents
Optional supplier details
Show child attributes
Show child attributes
Date and time the shipment was created
Optional note for inventory log when updating shipment
Response
Successful Response
ID of the stock
ID of the supplier
ID of the location where the shipment was delivered
Total quantity
Remaining quantity
Get the location name from the related location object
Unique identifier for the shipment
Optional lot number of the shipment
Optional expiry date of the shipment
Optional SKU (Stock Keeping Unit)
Cost of the shipment in cents
Optional supplier details
Show child attributes
Show child attributes
Date and time the shipment was created
Optional note for inventory log when updating shipment
