- Introduction
- OAuth
- HTTP Methods
- Response
- Errors
- Pagination
- Organizations
- Contacts
- Contact Persons
- Item Groups
- Items
- Composite Items
- Item Adjustments
- Transfer Orders
- Sales Orders
- Packages
- Shipment Orders
- Invoices
- Overview
- Create an invoice
- List invoices
- Update an invoice
- Get an invoice
- Delete an invoice
- Mark an invoice as sent
- Void an invoice
- Mark as draft
- Email an invoice
- Get invoice email content
- Email invoices
- Get payment reminder mail content
- Bulk export Invoices
- Bulk print invoices
- Disable payment reminder
- Enable payment reminder
- Write off invoice
- Cancel write off
- Update billing address
- Update shipping address
- List invoice templates
- Update invoice template
- List invoice payments
- List credits applied
- Apply credits
- Delete a payment
- Delete applied credit
- Add attachment to an invoice
- Update attachment preference
- Get an invoice attachment
- Delete an attachment
- Add comment
- List invoice comments & history
- Update comment
- Delete a comment
- Retainer Invoices
- Overview
- Create a retainer invoice
- List a retainer invoices
- update a retainer invoice
- Get a retainer invoice
- Delete a retainer invoice
- Mark a retainer invoice as sent
- Update retainer invoice template
- Void a retainer invoice
- Mark as draft
- Submit a retainer invoice for approval
- Approve a retainer invoice.
- Email a retainer invoice
- Get retainer invoice email content
- Update billing address
- List retainer invoice templates
- Add attachment to a retainer invoice
- Get a retainer invoice attachment
- Delete an attachment
- Add comment
- List retainer invoice comments & history
- Update comment
- Delete a comment
- Customer Payments
- Sales Returns
- Credit Notes
- Overview
- Create a credit note
- List all Credit Notes
- Update a credit note
- Get a credit note
- Delete a credit note
- Email a credit note
- Get email content
- Void a Credit Note
- Convert Credit Note to Draft
- Convert credit note to Open
- Submit a credit note for approval
- Approve a credit note
- Email history
- Update billing address
- Update Shipping address
- List the credit note templates
- Update a credit note template
- Apply credits to invoices
- List invoices credited
- Delete credits applied to an invoice
- Add a comment
- List credit note comments & history
- Delete a Comment
- List credit note refunds
- Refund credit note
- List refunds of a credit note
- Update credit note refund
- Get credit note refund
- Delete credit note refund
- Purchase Orders
- Purchase Receives
- Bills
- Vendor Credits
- Overview
- Create a vendor credit
- List vendor credits
- Update vendor credit
- Get vendor credit
- Delete vendor credit
- Convert to open
- Void vendor credit
- Submit a Vendor credit for approval
- Approve a Vendor credit
- Apply credits to a bill
- List bills credited
- Delete bills credited
- Refund a vendor credit
- List refunds of a vendor credit
- Update vendor credit refund
- Get vendor credit refund
- Delete vendor credit refund
- List vendor credit refunds
- Add a comment
- List vendor credit comments & history
- Delete a comment
- Warehouse Settings
- Price Lists
- Taxes
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.
- salesorder_idlong
Unique ID generated by the server for the Sales Order. This is used as identifier.
- salesorder_numberstring
The Sales Order number. This is unique for each sales order.
- shipment_idlong
Unique ID generated by the server for the shipment. This is used as an identifier.
- shipment_numberstring
Shipment number of the package.
- datestring
Date on which package is prepared
- statusstring
Status of the Shipment Order
- detailed_statusstring
Detailed shipment details received from the courier
- status_messagestring
Status message of the shipment.
- carrierstring
Carrier used for shipment.
- servicestring
Type of service selected for shipment
- delivery_daysinteger
Number of days taken by the courier for delivering in package
- delivery_guaranteeboolean
guarantee assured by the courier. For guaranteed on-time deliveries, it is true else it is false
- reference_numberstring
Tracking number for the Shipment.
- customer_idlong
Unique ID generated by the for the customer
- customer_namestring
Name of the customer
- contact_personsarray
Array of contact person IDs.
- currency_idlong
Unique ID generated by the server for the currency. This is used as an identifier.
- currency_codestring
Currency code.
- currency_symbolstring
The symbol for the selected currency.
- exchange_ratedouble
Exchange rate of the currency, with respect to the base currency.
- discount_amountdouble
Discount to be applied on the Sales Order.
- discountdouble
The percentage of Discount applied.
- is_discount_before_taxboolean
Used to check whether the discount is applied before tax or after tax.
- discount_typestring
Type of discount
- estimate_idlong
Unique ID generated by the server from the Estimate created in Zoho Books. This is used as an identifier.
- delivery_methodstring
Delivery method of the shipment.
- delivery_method_idlong
Unique ID generated by the server for the delivery method. This is used as an identifier.
- tracking_numberstring
Tracking number of shipment.
- line_itemsarray
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_idlong
Unique ID generated by the server for the item. This is used as an identifier.
- line_item_idlong
Unique ID generated by the server for each line item. This is used as an identifier.
- namestring
Name of the line item.
- descriptionstring
Description of the line item.
- item_orderinteger
The order of the line items, starts from 0 by default.
- bcy_ratedouble
Item rate in the organization's base currency.
- ratedouble
Rate / Selling Price of the line item.
- unitstring
Unit of line item.
- tax_idlong
Unique ID generated by the server for the tax. This is used as an identifier.
- tax_namestring
Name of the tax applied on the line item.
- tax_typestring
Denotes the type of the tax. This can either be a single tax or a tax group.
- tax_percentagedouble
Percentage of the tax.
- item_totaldouble
Total of line item.
- is_invoicedboolean
Checks whether the Sales Order has been invoiced or not.
- shipping_chargedouble
Shipping charges that are applied to the Shipment.
- sub_totaldouble
Sub total of the Sales Order.
- tax_totaldouble
Tax total of the Sales Order.
- totaldouble
Total amount of the Sales Order.
- taxesarray
Number of taxes applied on sales order. Each tax contains: tax_name and tax_amount.
Show Sub-Attributes
- tax_namestring
Name of the tax applied on the line item.
- tax_amountdouble
Amount of the tax.
- price_precisioninteger
The precision level for the price's decimal point in a Shipment.
- is_emailedboolean
Checks whether the Package has been emailed to the customer or not.
- billing_addressarray
Customer's billing address. It contains - address, city, state, zip, country and fax.
Show Sub-Attributes
- addressstring
Name of the street of the customer’s billing address.
- citystring
Name of the city of the customer’s billing address.
- statestring
Name of the state of the customer's billing address.
- zipstring
Zip code of the customer’s billing address.
- faxstring
Fax number of the customer’s billing address.
- shipping_addressarray
Customer's shipping address. It contains - address, city, state, zip, country and fax.
Show Sub-Attributes
- addressstring
Name of the street of the customer’s billing address.
- citystring
Name of the city of the customer’s billing address.
- statestring
Name of the state of the customer's billing address.
- zipstring
Zip code of the customer’s billing address.
- faxstring
Fax number of the customer’s billing address.
- template_idlong
Unique ID generated by the server for the Template. This is used as an identifier.
- template_namestring
Name of the template used for the Shipment.
- template_typestring
Type of the template.
- notesstring
Notes for package
- created_timestring
Time at which the Shipment Details was created.
- last_modified_timestring
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": 504366000000062000,
"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,
"fax": "324-524242"
}
],
"shipping_address": [
{
"address": "No:234,90 Church Street",
"city": "New York City",
"state": "New York",
"zip": 10048,
"fax": "324-524242"
}
],
"template_id": 4815000000017003,
"template_name": "Standard",
"template_type": "standard",
"notes": "notes",
"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 : ZakyaAPI.shipmentorders.CREATE
Arguments
- shipment_numberstring (Required)
Shipment number of the package.
- datestring (Required)
Date on which package is prepared
- reference_numberstring
Tracking number for the Shipment.
- contact_personsarray
Array of contact person IDs.
- delivery_methodstring (Required)
Delivery method of the shipment.
- tracking_numberstring (Required)
Tracking number of shipment.
- shipping_chargedouble
Shipping charges that are applied to the Shipment.
- exchange_ratedouble
Exchange rate of the currency, with respect to the base currency.
- template_idlong
Unique ID generated by the server for the Template. This is used as an identifier.
- notesstring
Notes for package
Query Parameters
- salesorder_id
Unique ID generated by the server for the Sales Order. This is used as identifier.
curl --request POST \
--url 'https://api.zakya.com/inventory/v1/shipmentorders?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://api.zakya.com/inventory/v1/shipmentorders?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection:
]
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://api.zakya.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 http = require("https");
const options = {
"method": "POST",
"hostname": "api.zakya.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();
const options = {
method: 'POST',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
'content-type': 'application/json'
},
body: '{"field1":"value1","field2":"value2"}'
};
fetch('https://api.zakya.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("api.zakya.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"))
{
"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"
}
{
"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": 504366000000062000,
"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,
"fax": "324-524242"
}
],
"shipping_address": [
{
"address": "No:234,90 Church Street",
"city": "New York City",
"state": "New York",
"zip": 10048,
"fax": "324-524242"
}
],
"template_id": 4815000000017003,
"template_name": "Standard",
"template_type": "standard",
"notes": "notes",
"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 : ZakyaAPI.shipmentorders.READ
curl --request GET \
--url 'https://api.zakya.com/inventory/v1/shipmentorders/?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://api.zakya.com/inventory/v1/shipmentorders/?organization_id=10234695"
type: GET
headers: headers_data
connection:
]
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://api.zakya.com/inventory/v1/shipmentorders/?organization_id=10234695")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const http = require("https");
const options = {
"method": "GET",
"hostname": "api.zakya.com",
"port": null,
"path": "/inventory/v1/shipmentorders/?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();
const options = {
method: 'GET',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://api.zakya.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("api.zakya.com")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/inventory/v1/shipmentorders/?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
{
"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": 504366000000062000,
"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,
"fax": "324-524242"
}
],
"shipping_address": [
{
"address": "No:234,90 Church Street",
"city": "New York City",
"state": "New York",
"zip": 10048,
"fax": "324-524242"
}
],
"template_id": 4815000000017003,
"template_name": "Standard",
"template_type": "standard",
"notes": "notes",
"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 : ZakyaAPI.shipmentorders.DELETE
curl --request DELETE \
--url 'https://api.zakya.com/inventory/v1/shipmentorders/?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://api.zakya.com/inventory/v1/shipmentorders/?organization_id=10234695"
type: DELETE
headers: headers_data
connection:
]
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://api.zakya.com/inventory/v1/shipmentorders/?organization_id=10234695")
.delete(null)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const http = require("https");
const options = {
"method": "DELETE",
"hostname": "api.zakya.com",
"port": null,
"path": "/inventory/v1/shipmentorders/?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();
const options = {
method: 'DELETE',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://api.zakya.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("api.zakya.com")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("DELETE", "/inventory/v1/shipmentorders/?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
{
"code": 0,
"message": "The Shipment Order has been deleted."
}
Mark as Delivered
Change the status of the Shipment to delivered.
OAuth Scope : ZakyaAPI.shipmentorders.CREATE
curl --request POST \
--url 'https://api.zakya.com/inventory/v1/shipmentorders//status/delivered?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://api.zakya.com/inventory/v1/shipmentorders//status/delivered?organization_id=10234695"
type: POST
headers: headers_data
connection:
]
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://api.zakya.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 http = require("https");
const options = {
"method": "POST",
"hostname": "api.zakya.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();
const options = {
method: 'POST',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://api.zakya.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("api.zakya.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"))
{
"code": 0,
"message": "The Shipment Order has been marked as Delivered."
}