Mandatory fields

Optional
SKU CREATION CATEGORY CREATION
VINCULUM UNI COMMERCE CLICKPOST VINCULUM
skuList categoryCode price ApiOwner
skuCode skuCode description ApiKey
skuName name sku merchId

Classification itemSku quantity extMerchCode

bomType quantity product_url merchName
parentMerchCod
bundledArticleList price invoice_value e
styleAttribute name invoice_number pageNumber
parentSKU itemType invoice_date fromDate
minimumTransferQ
ty type reference_number toDate

transferUnitFactor description length filterBy

detailDesc scanIdentifier breadth
Length length height
Width width weight
height height tin
weight weight images
size minOrderSize
color color
brand size
mrp brand
salePrice ean
Vendorcode upc
vendorName isbn
baseCost maxRetailPrice
taxCategory basePrice
isActive costPrice
lottableValidation gstTaxTypeCode
pdpURL hsnCode
serialTrackingRequi
red imageUrl
serialCount productPageUrl
isSaleable features
udf1 tat
udf2 tags
itemDetailFieldsTex
udf3 t
 requiresCustomizati
udf4 on
udf5 shelfLife
udf6 expirable
udf7 enabled
componentItemType
udf8 s
udf9 itemSku
udf10 quantity
imageURL price

category1 customFieldValues
category2 name
category3 value
category4
category5
lasthieracyCode
isBackOrder
backOrderQty
vendorSkuCode
upc_ean
barcodeType
material

isUniqueBarcode
pickingInstruction
shipingInstruction
careIntructions
budf1
budf2
budf3
budf4
budf5
budf6
budf7
budf8
isStocked
isPoisnous
isHazardous
shelfLifeIndicator
shelfType
totalShelfLife
shelfLifeOnPicking
shelfLifeOnReceivi
ng
skuLevelTaxCat
skuRotation
locations
countryOfOrigin
 CATEGORY CREATION
UNI COMMERCE CLICKPOST
code
name
gstTaxTypeCode

category
taxTypeCode

itemDetailFieldsText
hsnCode
grnExpiryTolerance

dispatchExpiryTolerance

returnExpiryTolerance
expirable
shelfLife
 Mandatory fields
Optional
Conditional
Object
ITEM CREATION
VINCULUM UNI COMMERCE CLICKPOST
order id pickup_name
order_location orderDate pickup_phone
uniqueKey orderStatus pickup_address
order_no sla pickup_city
order_type priority pickup_state
payment_type paymentType pickup_country
awbNo orderPrice pickup_pincode
status currency pickup_time
hold_status totalCashOnDeliveryCharges vendor_code
address_verified totalDiscount drop_name
payment_verified totalGiftCharges drop_address
address_type totalPrepaidAmount drop_phone
order_date totalShippingCharges drop_address
shipby_date orderItems drop_city
order_amount orderItemId drop_state
order_currency status drop_country
conversion_rate variantId drop_pincode
is_replacement productId drop_email
original_orderno sku return_info
is_replacement title tin
customer_code shippingMethodCode invoice_date
extCustomerCode orderItemPrice order_type
customer_name quantity cod_value
ship_address1 giftWrap items
ship_address2 onHold invoice_number
ship_address3 packetNumber invoice_value
ship_address4 taxExempted reference_number
ship_city cFormProvided email
ship_state thirdPartyShipping weight
ship_country shippingAddress length
ship_pincode addressLine1 height
ship_phone1 addressLine2 breadth
ship_phone2 city courier_partner
ship_email1 country gst_info
ship_email2 email reference_number
bill_name name email
bill_address1 phone weight
bill_address2 pincode length
bill_address3 state height
bill_address4 billingAddress
(same parameter as
bill_city shipping address)
bill_state additionalInfo
landmark
latitude
longitude
url
bill_country
bill_pincode
bill_phone1
bill_phone2
bill_email1
bill_email2
order_remarks
shipping_charges
other_charge1
other_charge2
store_credit
other_discount
discount_code
cancel_remark
is_giftwrap
giftwrap_msg
delivery_slot
udf1
udf2
udf3
udf4
udf5
udf6
udf7
udf8
udf9
udf10
custTinNo
pickAfterDate
giftwrapCharge
gvAmount
rewardPointsAmount
cust_type
req_type
pickupLocation
handoverValCode
items
lineno
sku
channelSkuCode
channelProductId
order_qty
cancelled_qty
unit_price
bundle_sku
bundle_price
bundle_qty
mrp
discount_amt
gift_voucher_amt
shipping_charges
other_charge1
transporter
store_credit
is_giftcard
vendor
mode
tax_inclusive
tax_percentage
udf1
udf2
udf3
udf4
udf5
locationCode
delFulfillmentMode
shipmentType
paymentItems
paymentMode
docNo
docdate
docBank
ifscCode
docAmt
amountreceived
branch
authCode
edcNo
udf1
udf2
udf3
udf4
udf5
 Order status (Responses)
VINCULUM UNI COMMERCE (param) UNI COMMERCE (desc)

pageNumber
pageSize = Fixed: 5
orderIds = comma
Query params: separated
shipped_time orders list of orders

delivered_time id Unique identifier for an order

Order creation date on
rto_time orderDate marketplace

rto_time orderStatus Status of the order

Max. time for which order

processing can be delayed,
beyond which the system will
start giving alerts to take
cir_picked_time sla action.
cir_picked_time priority Order fullfillment priority
cir_picked_time paymentType Mode of payment
Sale Order Pricing
return_received_time orderPrice Components
lit_time currency Currency codes (3 digit)

intransit_time totalCashonDeliveryCharges Charges for COD

ofd_time totalDiscount Discount amount
cir_out_for_pickup_time totalGiftCharges Gift charges

cir_pickup_failed_time totalPrepaidAmount Amount paid while ordering

invoice_date totalShippingCharges Shipping charges

undelivered_time orderItems List of items in an order

The ID of an item present

order_no orderItemId inside the order
 Generally same
as orderStatus. Only is case of
partial order fulfilment the
status of item in the order will
suborder_no status vary.
status productId Product ID of the item

invoice_no variantId Variant ID of the item

SKU code of the item on the
transporter_code sku marketplace

awb_no returnReason Reason for return

Date of return creation on
tax_amt returnDate marketplace
return_awb returnAWB Return tracking no.
return_received_remarks returnShippingProvider Return shipping provider
cir_delivered_time title Title of the item
The shipping method of the
packed_time shippingMethodcode order
return_qc_pass_time orderItemPrice Item price details
return_qc_fail_time cashOnDeliveryCharges COD charges
qc_remarks sellingPrice Selling price
courier_remarks shippingCharges Shipping charges
tax_group_code discount Discount amount
tax_perc totalPrice Total price
invoice_location transferPrice -

igst_percent currency Currency codes (3 digit)

cgst_percent quantity Qty of the item ordered
sgst_percent giftWrap Gift wrap details

igst_amount giftWrapMessage Message on the gift wrap

cgst_amount giftWrapCharges Extra charges for the wrap

true if order not available for
sgst_amount onHold processing

No. of parcels in which the

ship_igst_percent packetNumber order has to be processed
ship_cgst_percent taxExempted Tax Exemption on item
ship_sgst_percent cFormProvided Pre-GST configuration
true if the shipping to end
customer is taken care by the
Marketplace. false for self
ship_igst_amount thirdPartyShipping shipping
ship_cgst_amount shippingAddress Shipping address details

ship_sgst_amount addressLine1 Precise address of the facility

 Additional address
usn_unit_price addressLine2 information
po_code city City name
vendor_Loc_Code country Country name
po_tax_per email Email ID
client_inv_number name Name of receiver
phone Contact no.

pincode Area pincode (min. 6 digits)

state State name
billingAddress Billing address details

addressLine1 Precise address of the facility

Additional address
addressLine2 information
city City name
country Country name
email Email ID
name Name of receiver
phone Contact no.

pincode Area pincode (min. 6 digits)

state State name

additionalInfo Any additional information

der status (Responses)
CLICKPOST (param) CLICKPOST (desc)
The updated-order API retrieves the shipments which are updated between
specified start and end time.

username=<clickpost-username>
key=<clickpost-api-key>
start_date=1531980785
Request: end_date=1531984399
meta stores information about the API, success or failure

result is an array of records

created_at

timestamp

clickpost_status_description
clickpost_status_code
courier_partner

waybill
updated_at

account_code
reference_number
status

location

remark

The track-order API retrieves the historic statuses and the current status of the package.
(based on waybill numbers and courier_partner_id)

username=<clickpost-username>
key=<clickpost-api-key>
waybill=comma separated waybill numbers
Request: cp_id=courier_partner_id
meta stores information about the API, success or failure
result is an array of records
waybill (example:
SF18399217NER) AWB provided in the API. Is the key of each object.

latest_status

status

remarks
location
timestamp
clickpost_status_code

clickpost_status_description
clickpost_status_bucket
additional
is_stuck
dest_hub_inscan
order_detail
courier_partner_edd
rto_intransit_timestamp
ndr
{ndr_bucket_code,ndr_descrip
tion}
edd {min_sla,max_sla}
scans array of all scans against the shipment

clickpost_status_description

clickpost_status_code

clickpost_status_bucket

status
location
remark

tracking_id
timestamp

checkpoint_id
valid
 VINCULUM STATUS CODES
Warehouse Forward Status Warehouse return status
status
Delivery Status code Return status status code

Open SA Reverse Pick Up Initiaited RPI

Picked P Revrse Pick Up Done RPD

Packed I Reverse Pickup Delivered RPDL

Cancelled C Reverse Pick Up Terminated RPT

Shipped S
InTransit IT
Out For Delivery OFD

Delivered D
Lost InTransit LIT

RTO Initiatiated RTO

Un Delivered DAF
RTO Delivered RTOD

Return Received RR

Dropship forward status Dropship Return     status

status
Dropship forward status code Dropship return status status code

Ready for Ship I Confirmed CNF

Shipped S Reverse PickUP Delivered RPDL
Intransit IT Disputed DPT

Delivered D Cancelled CN

Ready for Pickup P Reverse PickUP Initiated RPI

Returned RR Reverse PickUP Done RPD

RTO RTO Reverse PickUP Terminated RPT

RTO Delivered RTOD
Out for Delivery OFD
Lost In Transit LIT

Un Delivered DAF
Cancelled C
 UNI COMMERCE STATUS CODES CLICKPOST STATUS CODES
orderStatus PENDING_VERIFICATION ORDER_PLACED

CREATED PICKUP_PENDING

PROCESSING PICKUP_FAILED

COMPLETE PICKED_UP

CANCELLED INTRANSIT

status CANCELLED OUT_FOR_DELIVERY

CREATED NOT_SERVICEABLE
PROCESSING DELIVERED
PACKED FAILED_DELIVERY

READY_TO_DISPATCH CANCELLED_ORDER
DISPATCHED RTO_REQUESTED

DELIVERED RTO
REPLACED RTO_OUT_FOR_DELIVERY
RETURN_REQUESTED RTO_DELIVERED

COURIER_RETURN RTO_FAILED

RETURNED LOST

DAMAGED

SHIPMENT_DELAYED
CONTACT_CUSTOMER_CAR
E
SHIPMENT_HELD

RTO_INTRANSIT

OUT_FOR_PICKUP
RTO_CONTACT_CUSTOMER
_CARE

RTO_SHIPMENT_DELAY
AWB REGISTERED
EXCHANGE_PICKUP
EXCHANGE_INTRANSIT

EXCHANGE_DELIVERED
RETURN ORDER PLACED