Shipments

A shipment represents the one or more items in an order. When an order has been completely fulfilled, it means that all the items that are included in the order have been sent to the customer. There can be more than one shipments for an order.

Attributes

Type

Description

id

integer

system generated unique id for a shipment

customerOrderNumber

string

order number for which a shipment is created

externalShipmentID

string

unique number of shipment in a channel

externalWarehouseID

string

warehouse reference number of a shipment

externalChannelID

string

sales channel name of client

orderDate

string

order created Date Time e.g: 2020-03-12 00:00:00

paymentType

string

Payment Method of order

expectedShipDate

string

expected date on which order should be shipped from facility e.g: 2020-03-13 00:00:00

externalManifestNumber

string

manifest number assigned for the shipment

channelManifestNumber

string

manifested number assigned by vendor for a shipment

order_id

integer

system generated id of an order

channel_id

integer

id of a sales channel

warehouse_id

integer

id of warehouse

account_id

integer

account id of a channel

channelSlug

string

unique slug of a channel

region

string

region of shipment

invoiceNumber

string

invoice number of a shipment (generated at the time of packed )

invoice_url

string

invoice url of a shipment

invoiceDate

string

date time on which the invoice has been generated

label_url

string

label url of a shipment

dimension_length

string

length of a shipment

dimension_width

string

width of a shipment

dimension_height

string

height of a shipment

weight

string

weight if a shipment

trackingID

string

tracking id generated for a shipment

courierName

string

courier name belongs to the trackind id

status

string

latest status of shipment

remarks

string

latest remark on shipment

status_updated_at

string

latest status updated date time

customerName

string

billing customer name

customerContactNumber

string

billing contact name

email

string

billing email id of a customer

status_log

object

status object of a shipment

status_log.status

string

statuses of a shipment

shippingAddress

object

shipping address object

shippingAddress.customerName

string

shippingAddress customer Name

shippingAddress.addressLine1

string

shipping address line first

shippingAddress.addressLine2

string

shipping address line second

shippingAddress.city

string

shipping address city

shippingAddress.state

string

shipping address state

shippingAddress.postalCode

string

shipping postal code

shippingAddress.countryCode

string

shipping country code

shippingAddress.countryName

string

shipping country name

shippingAddress.contactPhone

string

shipping address contact number

shippingAddress.email

string

shipping address email ID

isCOD

string

Type of order Enum : 0 , 1(1 if order is cod,0 if order is prepaid)

track_payload

object

latest track payload object of a shipment

track_payload.clickPostTrackData

object

shipment track data object

clickPostTrackData.timestamp

string

clickPostTrackData.account_code

string

courier account code

clickPostTrackData.status

string

status from courier o shipment

clickPostTrackData.waybill

string

tracking number of shipment

clickPostTrackData.cp_id

integer

courier partner id of courier

clickPostTrackData.clickpost_status_description

string

message discription from courier on a status

clickPostTrackData.remark

string

remark of status

clickPostTrackData.clickpost_status_code

integer

status code of a status on shipment

clickPostTrackData.additional

object

addtional detail object

additional.is_rvp

boolean

true if shipment is reverse, o if shipment is forward

additional.destination_hub_inscan_ts

string

additional.courier_partner_edd

string

additional.latest_status

object

current status of courier

timestamp

string

time stamp on which latest status happens

status

string

status of courier, can be same as latest_status

remark

string

remark of a status

clickpost_status_bucket

string

reference_number

string

shipment number ,It is same as externalChannelID

clickpost_status_description

string

description of status

clickpost_status_bucket_description

string

clickpost_status_code

string

status code of a status

location

string

current location of a shipment

packed_date

string

shipment packed date (yyyy-mm-dd h:m:s)

items

array[object]

items object

created_at

string

create timestamp of shipment

updated_at

string

update timestamp of shipment

The Items Object

Attributes

type

description

items[].lineItemSequenceNumber

integer

incremental id of each item in a order

items[].orderItemID

string

unique generated id by eshopbox

items[].itemID

string

variant id of item (seller SKU code)

items[].sku

string

sku of item

items[].productName

string

name of the item

items[].quantity

integer

quantity of the item

items[].customerPrice

number

unit price of item

items[].lineItemTotal

number

total price of item

items[].invoiceTotal

number

total price of item

items[].discount

number

discount on item

items[].taxRate

number

tax rate on item

items[].taxAmount

number

tax amount on item

items[].productImageUrl

string

product image url of item

items[].productAdditionalInfo

object

additional info of item

items[].productAdditionalInfo.color

string

color of item

items[].productAdditionalInfo.size

string

size of item

items[].shippingCharges

number

shipping charges of item

items[].productUrl

string

product url of item

The productAdditionInfo Object

Attributes

Type

Description

productAdditionalInfo.color

string

Color of the item

productAdditionalInfo.size

string

Size of the item

Enum: isCOD

Attribute

Description

0

created order must be Prepaid

1

created order must be COD

Last updated