• Home
  • Video
home/Smarttrack/Add Shipment/Parameters

Parameters

9 views 0 September 20, 2022 smartadmin

FieldTypeRequiredDescription
sender_country_isostring (2)YesSender country iso code
service_codestring (9)YesThis is code of the Service that we are using
order_referencestring (40)YesThis is order reference number
referencestring (40)NoThis is reference for your shipment
sender_contactstring (40)YesName of the Sender
sender_emailstring (45)NoEmail of the Sender
sender_companystring (25)NoCompany Name of the Sender
sender_namestring (25)NoName of the Sender
sender_address_line_1string (30)YesAddress 1 of the sender
sender_address_line_2string (30)NoAddress 2 of the sender
sender_address_line_3string (30)NoAddress 3 of the sender
sender_citystring (25)YesCity of the sender
sender_statestring (25)NoState of the sender
sender_postcodestring (10)YesPostcode of the city of sender
sender_telephonestring (17)NoPhone Number of the sender
receiver_country_isostring (2)YesReceiver country iso code (2)
receiver_emailstring (45)NoEmail of the receiver
receiver_companystring (25)NoCompany Name of the receiver
receiver_contactstring (50)YesName of the receiver
receiver_address_line_1string (40)YesAddress 1 of the receiver
receiver_address_line_2string (40)NoAddress 2 of the receiver
receiver_address_line_3string (40)NoAddress 3 of the receiver
receiver_citystring (25)YesCity of the receiver
receiver_statestring (25)NoState of the receiver
receiver_postcodestring (10)YesPostcode of the city of receiver
receiver_telephonestring (17)NoPhone Number of the receiver
valueInteger (12)NoValue of shipped goods
currencystring (3)NoCurrency iso code
item_typestring (60)NoType of Consignment
NotesstringNoAny Notes that sender adds for the Consignment
descriptionstring (30)YesAny description that sender adds for the Consignment
tracking_numberstring (30)NoTracking number of shipment
shipment_typestringNoPossible values are D and C
D for dispatch type shipment
C for collection type shipment
Default value is D
commercial_invoiceBASE64_ENCODED_PDF_STRINGNoPDF string
collection_datedateNoOnly for collection type shipment
Date format should be dd-mm-yyyy
collection_start_timetimeNoOnly for collection type shipment
Time format should be in 24 hours format like 13:30
collection_end_timetimeNoOnly for collection type shipment
Time format should be in 24 hours format like 13:30
eori_numberstringNo
vat_numberstringNo
ioss_numberstringNo
seller_namestringNo
seller_companystringNo
seller_emailstringNo
seller_phonestringNo
seller_address_line_1stringNo
seller_address_line_2stringNo
seller_address_line_3stringNo
seller_citystringNo
seller_statestringNo
seller_postcodestringNo
seller_country_isostringNo
full_palletint (Length 2)No
half_palletint (Length 2)No
quarter_palletint (Length 2)No
seller_documentsArrayNoArray of KYC documents
parcel[0][weight]ArrayYesWeight of the parcel. it will send in array Like parcel[0][weight] : 5
parcel[0][height]ArrayYesHeight of the parcel. it will send in array Like parcel[0][height] : 10
parcel[0][width]ArrayYesWidth of the parcel. it will send in array Like parcel[0][width] : 10
parcel[0][length]ArrayYesLength of the parcel. it will send in array Like parcel[0][length] :10
parcel[0][tracking_number]ArrayNoTracking number of the parcel. it will send in array Like parcel[0][tracking_number] :jd000000054213
parcel[0][ itemvalue]ArrayNoItem value of the parcel. it will send in array Like parcel[0][itemvalue]: 10
parcel[0][items][0][item_description]ArrayNoItem description of the items inside a parcel. it will send in array Like parcel[0][items][0][item_description]: “jellyfish”,
parcel[0][items][0][item_sku]ArrayNoSKU of items inside the parcel. it will send in array Like parcel[0][items][0][item_sku]: “SKU”,
parcel[0][items][0][item_url]ArrayNoProduct url of items inside the parcel. it will send in array Like parcel[0][items][0][item_url]: “http://www.abc.com”,
parcel[0][items][0][no_of_items]ArrayNoNo of items inside a parcel. it will send in array Like parcel[0][items][0][no_of_items]: 1,
parcel[0][items][0][item_value]ArrayNoValue of items inside a parcel. it will send in array Like parcel[0][items][0][item_value]: 1,
parcel[0][items][0][weight]ArrayNoWeight of items inside a parcel. it will send in array Like parcel[0][items][0][weight]: 0.750,
parcel[0][items][0][tariff_No]ArrayNoTariff of items inside a parcel. it will send in array Like parcel[0][items][0][tariff_No]: TARIFF1,
parcel[0][items][0][hscode]ArrayNoHscode of items inside a parcel. it will send in array Like parcel[0][items][0][hscode]: hscode,
parcel[0][items][0][manufacture_country_iso]ArrayNoManufacture country ISO of items inside a parcel. it will send in array Like parcel[0][items][0][manufacture_country_iso]: GB,

Was this helpful?

Yes  No
Related Articles
  • Error Response
  • Success Response
  • Request
  • Request URL
  • Description
New title
  • Get Label
  • Get Bulk Label
  • Get Tracking
  • Void Labels
  • Get Quotes
  • Scanning
  • Get Started
  • Get Authentication
  • Get Services
  • Add Shipment
  • Add Multi Shipment
  • Add Shipment & get Label

  Request URL

Request  

  • Copyright 2024 Smarttrack All Rights Reserved.