Shipment Orders

A document used by an organization to specify what items or packages are to be transferred from a storage location or warehouse to what person and to what new location is called a shipment order. It is typically sent along with a shipment of goods so that the person receiving them(your customer) can verify that the document correctly reflects the items that they actually received.

End Points

POST

/shipmentorders

PUT

/shipmentorders/{shipmentorder_id}

GET

/shipmentorders/{shipmentorder_id}

DELETE

/shipmentorders/{shipmentorder_id}

POST

/shipmentorders/{shipmentorder_id}/status/delivered

Attribute

salesorder_id

long

Unique ID generated by the server for the Sales Order. This is used as identifier.

salesorder_number

string

The Sales Order number. This is unique for each sales order.

shipment_id

long

Unique ID generated by the server for the shipment. This is used as an identifier.

shipment_number

string

Shipment number of the package.

date

string

Date on which package is prepared

status

string

Status of the Shipment Order

detailed_status

string

Detailed shipment details received from the courier

status_message

string

Status message of the shipment.

carrier

string

Carrier used for shipment.

service

string

Type of service selected for shipment

delivery_days

integer

Number of days taken by the courier for delivering in package

delivery_guarantee

boolean

guarantee assured by the courier. For guaranteed on-time deliveries, it is true else it is false

reference_number

string

Tracking number for the Shipment.

customer_id

long

Unique ID generated by the for the customer

customer_name

string

Name of the customer

contact_persons

array

Array of contact person IDs.

currency_id

long

Unique ID generated by the server for the currency. This is used as an identifier.

currency_code

string

Currency code.

currency_symbol

string

The symbol for the selected currency.

exchange_rate

double

Exchange rate of the currency, with respect to the base currency.

discount_amount

double

Discount to be applied on the Sales Order.

discount

double

The percentage of Discount applied.

is_discount_before_tax

boolean

Used to check whether the discount is applied before tax or after tax.

discount_type

string

Type of discount

estimate_id

long

Unique ID generated by the server from the Estimate created in Zoho Books. This is used as an identifier.

delivery_method

string

Delivery method of the shipment.

delivery_method_id

long

Unique ID generated by the server for the delivery method. This is used as an identifier.

tracking_number

string

Tracking number of shipment.

line_items

array

List of items in a package. Each line item contains line_item_id,item_id,name,description,item_order,bcy_rate,rate,quantity,unit,tax_id,tax_name,tax_type,tax_percentage,item_total,is_invoiced.

Show Sub-Attributes

item_id

long

Unique ID generated by the server for the item. This is used as an identifier.

line_item_id

long

Unique ID generated by the server for each line item. This is used as an identifier.

name

string

Name of the line item.

description

string

Description of the line item.

item_order

integer

The order of the line items, starts from 0 by default.

bcy_rate

double

Item rate in the organization's base currency.

rate

double

Rate / Selling Price of the line item.

unit

string

Unit of line item.

tax_id

long

Unique ID generated by the server for the tax. This is used as an identifier.

tax_name

string

Name of the tax applied on the line item.

tax_type

string

Denotes the type of the tax. This can either be a single tax or a tax group.

tax_percentage

double

Percentage of the tax.

item_total

double

Total of line item.

is_invoiced

boolean

Checks whether the Sales Order has been invoiced or not.

shipping_charge

double

Shipping charges that are applied to the Shipment.

sub_total

double

Sub total of the Sales Order.

tax_total

double

Tax total of the Sales Order.

total

double

Total amount of the Sales Order.

taxes

array

Number of taxes applied on sales order. Each tax contains: tax_name and tax_amount.

Show Sub-Attributes

tax_name

string

Name of the tax applied on the line item.

tax_amount

double

Amount of the tax.

price_precision

integer

The precision level for the price's decimal point in a Shipment.

is_emailed

boolean

Checks whether the Package has been emailed to the customer or not.

billing_address

array

Customer's billing address. It contains - address, city, state, zip, country and fax.

Show Sub-Attributes

address

string

Name of the street of the customer’s billing address.

city

string

Name of the city of the customer’s billing address.

state

string

Name of the state of the customer's billing address.

zip

string

Zip code of the customer’s billing address.

country

string

Name of the country of the customer’s billing address.

fax

string

Fax number of the customer’s billing address.

shipping_address

array

Customer's shipping address. It contains - address, city, state, zip, country and fax.

Show Sub-Attributes

address

string

Name of the street of the customer’s billing address.

city

string

Name of the city of the customer’s billing address.

state

string

Name of the state of the customer's billing address.

zip

string

Zip code of the customer’s billing address.

country

string

Name of the country of the customer’s billing address.

fax

string

Fax number of the customer’s billing address.

template_id

long

Unique ID generated by the server for the Template. This is used as an identifier.

template_name

string

Name of the template used for the Shipment.

template_type

string

Type of the template.

notes

string

Notes for package

custom_fields

array

Custom fields for a shipmentorder.

Show Sub-Attributes

customfield_id

long

value

string

Value of the Custom Field

created_time

string

Time at which the Shipment Details was created.

last_modified_time

string

Time at which the Shipment Details details were last modified.

{
    "salesorder_id": 4815000000044895,
    "salesorder_number": "SO-00003",
    "shipment_id": 4815000000044917,
    "shipment_number": "SH-00004",
    "date": "2017-01-11",
    "status": "shipped",
    "detailed_status": "Reached a courier facility near Toronto.",
    "status_message": "Shipped",
    "carrier": "FedEx",
    "service": "FEDEX_2_DAY",
    "delivery_days": 2,
    "delivery_guarantee": true,
    "reference_number": "TKG424242",
    "customer_id": 481500000000062000,
    "customer_name": "Peter James",
    "contact_persons": 4815000000044080,
    "currency_id": 4815000000000097,
    "currency_code": "USD",
    "currency_symbol": "$",
    "exchange_rate": 1,
    "discount_amount": 0,
    "discount": "20.00%",
    "is_discount_before_tax": true,
    "discount_type": "entity_level",
    "estimate_id": 4815000000045091,
    "delivery_method": "FedEx",
    "delivery_method_id": 4815000000044822,
    "tracking_number": "TRK214124124",
    "line_items": [
        {
            "item_id": 4815000000044100,
            "line_item_id": 4815000000044897,
            "name": "Laptop-white/15inch/dell",
            "description": "Just a sample description.",
            "item_order": 0,
            "bcy_rate": 122,
            "rate": 122,
            "unit": "qty",
            "tax_id": 4815000000044043,
            "tax_name": "Sales Tax",
            "tax_type": "tax",
            "tax_percentage": 12,
            "item_total": 244,
            "is_invoiced": true
        }
    ],
    "shipping_charge": 7,
    "sub_total": 244,
    "tax_total": 29,
    "total": 350,
    "taxes": [
        {
            "tax_name": "Sales Tax",
            "tax_amount": 29.28
        }
    ],
    "price_precision": 2,
    "is_emailed": true,
    "billing_address": [
        {
            "address": "No:234,90 Church Street",
            "city": "New York City",
            "state": "New York",
            "zip": 10048,
            "country": "U.S.A",
            "fax": "324-524242"
        }
    ],
    "shipping_address": [
        {
            "address": "No:234,90 Church Street",
            "city": "New York City",
            "state": "New York",
            "zip": 10048,
            "country": "U.S.A",
            "fax": "324-524242"
        }
    ],
    "template_id": 4815000000017003,
    "template_name": "Standard",
    "template_type": "standard",
    "notes": "notes",
    "custom_fields": [
        {
            "customfield_id": "4815000000012845",
            "value": "Normal"
        }
    ],
    "created_time": "2015-05-28T00:00:00.000Z",
    "last_modified_time": "2015-05-28T00:00:00.000Z"
}

Create a Shipment Order

A new shipment order can a be created. To create shipment, URL parameter's package_ids and salesorder_id are mandatory.
OAuth Scope : ZohoInventory.shipmentorders.CREATE

Arguments

shipment_number

string

(Required)

Shipment number of the package.

date

string

(Required)

Date on which package is prepared

reference_number

string

Tracking number for the Shipment.

contact_persons

array

Array of contact person IDs.

delivery_method

string

(Required)

Delivery method of the shipment.

tracking_number

string

(Required)

Tracking number of shipment.

shipping_charge

double

Shipping charges that are applied to the Shipment.

exchange_rate

double

Exchange rate of the currency, with respect to the base currency.

template_id

long

Unique ID generated by the server for the Template. This is used as an identifier.

notes

string

Notes for package

custom_fields

array

Custom fields for a shipmentorder.

Show Sub-Attributes

customfield_id

long

value

string

Value of the Custom Field

Query Parameters

salesorder_id

Unique ID generated by the server for the Sales Order. This is used as identifier.

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/shipmentorders?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/shipmentorders?organization_id=10234695")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/inventory/v1/shipmentorders?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/inventory/v1/shipmentorders?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/shipmentorders?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/inventory/v1/shipmentorders?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "shipment_number": "SH-00004",
    "date": "2017-01-11",
    "reference_number": "TKG424242",
    "contact_persons": 4815000000044080,
    "delivery_method": "FedEx",
    "tracking_number": "TRK214124124",
    "shipping_charge": 7,
    "exchange_rate": 1,
    "template_id": 4815000000017003,
    "notes": "notes",
    "custom_fields": [
        {
            "customfield_id": "4815000000012845",
            "value": "Normal"
        }
    ]
}

{
    "code": 0,
    "message": "Shipment created successfully.",
    "shipment_order": {
        "salesorder_id": 4815000000044895,
        "salesorder_number": "SO-00003",
        "shipment_id": 4815000000044917,
        "shipment_number": "SH-00004",
        "date": "2017-01-11",
        "status": "shipped",
        "detailed_status": "Reached a courier facility near Toronto.",
        "status_message": "Shipped",
        "carrier": "FedEx",
        "service": "FEDEX_2_DAY",
        "delivery_days": 2,
        "delivery_guarantee": true,
        "reference_number": "TKG424242",
        "customer_id": 481500000000062000,
        "customer_name": "Peter James",
        "contact_persons": 4815000000044080,
        "currency_id": 4815000000000097,
        "currency_code": "USD",
        "currency_symbol": "$",
        "exchange_rate": 1,
        "discount_amount": 0,
        "discount": "20.00%",
        "is_discount_before_tax": true,
        "discount_type": "entity_level",
        "estimate_id": 4815000000045091,
        "delivery_method": "FedEx",
        "delivery_method_id": 4815000000044822,
        "tracking_number": "TRK214124124",
        "line_items": [
            {
                "item_id": 4815000000044100,
                "line_item_id": 4815000000044897,
                "name": "Laptop-white/15inch/dell",
                "description": "Just a sample description.",
                "item_order": 0,
                "bcy_rate": 122,
                "rate": 122,
                "unit": "qty",
                "tax_id": 4815000000044043,
                "tax_name": "Sales Tax",
                "tax_type": "tax",
                "tax_percentage": 12,
                "item_total": 244,
                "is_invoiced": true
            }
        ],
        "shipping_charge": 7,
        "sub_total": 244,
        "tax_total": 29,
        "total": 350,
        "taxes": [
            {
                "tax_name": "Sales Tax",
                "tax_amount": 29.28
            }
        ],
        "price_precision": 2,
        "is_emailed": true,
        "billing_address": [
            {
                "address": "No:234,90 Church Street",
                "city": "New York City",
                "state": "New York",
                "zip": 10048,
                "country": "U.S.A",
                "fax": "324-524242"
            }
        ],
        "shipping_address": [
            {
                "address": "No:234,90 Church Street",
                "city": "New York City",
                "state": "New York",
                "zip": 10048,
                "country": "U.S.A",
                "fax": "324-524242"
            }
        ],
        "template_id": 4815000000017003,
        "template_name": "Standard",
        "template_type": "standard",
        "notes": "notes",
        "custom_fields": [
            {
                "customfield_id": "4815000000012845",
                "value": "Normal"
            }
        ],
        "created_time": "2015-05-28T00:00:00.000Z",
        "last_modified_time": "2015-05-28T00:00:00.000Z"
    }
}

Update a Shipment Order

Update details of an existing Shipment Order in Zoho Inventory.
OAuth Scope : ZohoInventory.shipmentorders.UPDATE

Arguments

shipment_number

string

(Required)

Shipment number of the package.

date

string

(Required)

Date on which package is prepared

reference_number

string

Tracking number for the Shipment.

contact_persons

array

Array of contact person IDs.

delivery_method

string

(Required)

Delivery method of the shipment.

tracking_number

string

Tracking number of shipment.

shipping_charge

double

Shipping charges that are applied to the Shipment.

exchange_rate

double

Exchange rate of the currency, with respect to the base currency.

template_id

long

Unique ID generated by the server for the Template. This is used as an identifier.

notes

string

Notes for package

custom_fields

array

Custom fields for a shipmentorder.

Show Sub-Attributes

customfield_id

long

value

string

Value of the Custom Field

Query Parameters

package_ids

(Required)

Array of package_id(s) to be shipped

salesorder_id

(Required)

Unique ID generated by the server for the Sales Order. This is used as identifier.

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/shipmentorders/4815000000044598?organization_id=10234695&package_ids=4815000000017005,4815000000017006&salesorder_id=4815000000044895"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/shipmentorders/4815000000044598?organization_id=10234695&package_ids=4815000000017005%2C4815000000017006&salesorder_id=4815000000044895")
  .put(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/inventory/v1/shipmentorders/4815000000044598?organization_id=10234695&package_ids=4815000000017005%2C4815000000017006&salesorder_id=4815000000044895', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/inventory/v1/shipmentorders/4815000000044598?organization_id=10234695&package_ids=4815000000017005%2C4815000000017006&salesorder_id=4815000000044895", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/shipmentorders/4815000000044598?organization_id=10234695&package_ids=4815000000017005%2C4815000000017006&salesorder_id=4815000000044895",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url 'https://www.zohoapis.com/inventory/v1/shipmentorders/4815000000044598?organization_id=10234695&package_ids=4815000000017005%2C4815000000017006&salesorder_id=4815000000044895' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "shipment_number": "SH-00004",
    "date": "2017-01-11",
    "reference_number": "TKG424242",
    "contact_persons": 4815000000044080,
    "delivery_method": "FedEx",
    "tracking_number": "TRK214124124",
    "shipping_charge": 7,
    "exchange_rate": 1,
    "template_id": 4815000000017003,
    "notes": "notes",
    "custom_fields": [
        {
            "customfield_id": "4815000000012845",
            "value": "Normal"
        }
    ]
}

{
    "code": 0,
    "message": "Shipment Order updated successfully.",
    "shipmentorder": {
        "salesorder_id": 4815000000044895,
        "salesorder_number": "SO-00003",
        "shipment_id": 4815000000044917,
        "shipment_number": "SH-00004",
        "date": "2017-01-11",
        "status": "shipped",
        "detailed_status": "Reached a courier facility near Toronto.",
        "status_message": "Shipped",
        "carrier": "FedEx",
        "service": "FEDEX_2_DAY",
        "delivery_days": 2,
        "delivery_guarantee": true,
        "reference_number": "TKG424242",
        "customer_id": 481500000000062000,
        "customer_name": "Peter James",
        "contact_persons": 4815000000044080,
        "currency_id": 4815000000000097,
        "currency_code": "USD",
        "currency_symbol": "$",
        "exchange_rate": 1,
        "discount_amount": 0,
        "discount": "20.00%",
        "is_discount_before_tax": true,
        "discount_type": "entity_level",
        "estimate_id": 4815000000045091,
        "delivery_method": "FedEx",
        "delivery_method_id": 4815000000044822,
        "tracking_number": "TRK214124124",
        "line_items": [
            {
                "item_id": 4815000000044100,
                "line_item_id": 4815000000044897,
                "name": "Laptop-white/15inch/dell",
                "description": "Just a sample description.",
                "item_order": 0,
                "bcy_rate": 122,
                "rate": 122,
                "unit": "qty",
                "tax_id": 4815000000044043,
                "tax_name": "Sales Tax",
                "tax_type": "tax",
                "tax_percentage": 12,
                "item_total": 244,
                "is_invoiced": true
            }
        ],
        "shipping_charge": 7,
        "sub_total": 244,
        "tax_total": 29,
        "total": 350,
        "taxes": [
            {
                "tax_name": "Sales Tax",
                "tax_amount": 29.28
            }
        ],
        "price_precision": 2,
        "is_emailed": true,
        "billing_address": [
            {
                "address": "No:234,90 Church Street",
                "city": "New York City",
                "state": "New York",
                "zip": 10048,
                "country": "U.S.A",
                "fax": "324-524242"
            }
        ],
        "shipping_address": [
            {
                "address": "No:234,90 Church Street",
                "city": "New York City",
                "state": "New York",
                "zip": 10048,
                "country": "U.S.A",
                "fax": "324-524242"
            }
        ],
        "template_id": 4815000000017003,
        "template_name": "Standard",
        "template_type": "standard",
        "notes": "notes",
        "custom_fields": [
            {
                "customfield_id": "4815000000012845",
                "value": "Normal"
            }
        ],
        "created_time": "2015-05-28T00:00:00.000Z",
        "last_modified_time": "2015-05-28T00:00:00.000Z"
    }
}

Retrieve a Shipment Order

Retrieves details for an existing Shipment Orders.
OAuth Scope : ZohoInventory.shipmentorders.READ

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/shipmentorders/4815000000044598?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/shipmentorders/4815000000044598?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v1/shipmentorders/4815000000044598?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/inventory/v1/shipmentorders/4815000000044598?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/shipmentorders/4815000000044598?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/inventory/v1/shipmentorders/4815000000044598?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "shipment_order": {
        "salesorder_id": 4815000000044895,
        "salesorder_number": "SO-00003",
        "shipment_id": 4815000000044917,
        "shipment_number": "SH-00004",
        "date": "2017-01-11",
        "status": "shipped",
        "detailed_status": "Reached a courier facility near Toronto.",
        "status_message": "Shipped",
        "carrier": "FedEx",
        "service": "FEDEX_2_DAY",
        "delivery_days": 2,
        "delivery_guarantee": true,
        "reference_number": "TKG424242",
        "customer_id": 481500000000062000,
        "customer_name": "Peter James",
        "contact_persons": 4815000000044080,
        "currency_id": 4815000000000097,
        "currency_code": "USD",
        "currency_symbol": "$",
        "exchange_rate": 1,
        "discount_amount": 0,
        "discount": "20.00%",
        "is_discount_before_tax": true,
        "discount_type": "entity_level",
        "estimate_id": 4815000000045091,
        "delivery_method": "FedEx",
        "delivery_method_id": 4815000000044822,
        "tracking_number": "TRK214124124",
        "line_items": [
            {
                "item_id": 4815000000044100,
                "line_item_id": 4815000000044897,
                "name": "Laptop-white/15inch/dell",
                "description": "Just a sample description.",
                "item_order": 0,
                "bcy_rate": 122,
                "rate": 122,
                "unit": "qty",
                "tax_id": 4815000000044043,
                "tax_name": "Sales Tax",
                "tax_type": "tax",
                "tax_percentage": 12,
                "item_total": 244,
                "is_invoiced": true
            }
        ],
        "shipping_charge": 7,
        "sub_total": 244,
        "tax_total": 29,
        "total": 350,
        "taxes": [
            {
                "tax_name": "Sales Tax",
                "tax_amount": 29.28
            }
        ],
        "price_precision": 2,
        "is_emailed": true,
        "billing_address": [
            {
                "address": "No:234,90 Church Street",
                "city": "New York City",
                "state": "New York",
                "zip": 10048,
                "country": "U.S.A",
                "fax": "324-524242"
            }
        ],
        "shipping_address": [
            {
                "address": "No:234,90 Church Street",
                "city": "New York City",
                "state": "New York",
                "zip": 10048,
                "country": "U.S.A",
                "fax": "324-524242"
            }
        ],
        "template_id": 4815000000017003,
        "template_name": "Standard",
        "template_type": "standard",
        "notes": "notes",
        "custom_fields": [
            {
                "customfield_id": "4815000000012845",
                "value": "Normal"
            }
        ],
        "created_time": "2015-05-28T00:00:00.000Z",
        "last_modified_time": "2015-05-28T00:00:00.000Z"
    }
}

Delete a Shipment Order

Deletes an existing Shipment Order.
OAuth Scope : ZohoInventory.shipmentorders.DELETE

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/shipmentorders/4815000000044598?organization_id=10234695"
type: DELETE
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/shipmentorders/4815000000044598?organization_id=10234695")
  .delete(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'DELETE',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v1/shipmentorders/4815000000044598?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("DELETE", "/inventory/v1/shipmentorders/4815000000044598?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "DELETE",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/shipmentorders/4815000000044598?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request DELETE \
  --url 'https://www.zohoapis.com/inventory/v1/shipmentorders/4815000000044598?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The Shipment Order has been deleted."
}

Mark as Delivered

Change the status of the Shipment to delivered.
OAuth Scope : ZohoInventory.shipmentorders.CREATE

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/shipmentorders//status/delivered?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/shipmentorders//status/delivered?organization_id=10234695")
  .post(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v1/shipmentorders//status/delivered?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("POST", "/inventory/v1/shipmentorders//status/delivered?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/shipmentorders//status/delivered?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/inventory/v1/shipmentorders//status/delivered?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The Shipment Order has been marked as Delivered."
}