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

Parameters

9 views 0 September 20, 2022 smartadmin

Sender

FieldTypeRequiredDescription
shipments[1][sender_country_iso]string (2)YesSender country iso code
shipments[1][service_code]string (9)YesThis is code of the Service that we are using
shipments[1][order_reference]string (40)YesThis is order reference number
shipments[1][reference]string (40)NoThis is reference for your shipment
shipments[1][sender_contact]string (40)YesName of the Sender
shipments[1][sender_email]string (45)NoEmail of the Sender
shipments[1][sender_company]string (25)NoCompany Name of the Sender
shipments[1][sender_name]string (25)NoName of the Sender
shipments[1][sender_address_line_1]string (30)YesAddress 1 of the sender
shipments[1][sender_address_line_2]string (30)NoAddress 2 of the sender
shipments[1][sender_address_line_3]string (30)NoAddress 3 of the sender
shipments[1][sender_city]string (25)YesCity of the sender
shipments[1][sender_state]string (25)NoState of the sender
shipments[1][sender_postcode]string (10)YesPostcode of the city of sender
shipments[1][sender_telephone]string (17)NoPhone Number of the sender
shipments[1][receiver_country_iso]string (2)YesReceiver country iso code (2)
shipments[1][receiver_email]string (45)NoEmail of the receiver
shipments[1][receiver_company]string (25)NoCompany Name of the receiver
shipments[1][receiver_contact]string (50)YesName of the receiver
shipments[1][receiver_address_line_1]string (40)YesAddress 1 of the receiver
shipments[1][receiver_address_line_2]string (40)NoAddress 2 of the receiver
shipments[1][receiver_address_line_3]string (40)NoAddress 3 of the receiver
shipments[1][receiver_city]string (25)YesCity of the receiver
shipments[1][receiver_state]string (25)NoState of the receiver
shipments[1][receiver_postcode]string (10)YesPostcode of the city of receiver
shipments[1][receiver_telephone]string (17)NoPhone Number of the receiver
shipments[1][value]Int (12)NoValue of shipped goods
shipments[1][shipment_type]stringNoPossible 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
shipments[1][collection_date]dateNoOnly for collection type shipment
Date format should be dd-mm-yyyy
shipments[1][collection_start_time]timeNoOnly for collection type shipment
Time format should be in 24 hours format like 13:30
shipments[1][collection_end_time]timeNoOnly for collection type shipment
Time format should be in 24 hours format like 13:30
shipments[1][currency]string (3)NoCurrency iso code
shipments[1][item_type]string (60)NoType of Consignment
shipments[1][Notes]stringNoAny Notes that sender adds for the Consignment
shipments[1][description]string (30)YesAny description that sender adds for the Consignment
shipments[1][eori_number]string (20)No
shipments[1][vat_number]string (20)No
shipments[1][ioss_number]string (20)No
shipments[1][seller_name]stringNo
shipments[1][seller_company]stringNo
shipments[1][seller_email]stringNo
shipments[1][seller_phone]stringNo
shipments[1][seller_address_line_1]stringNo
shipments[1][seller_address_line_2]stringNo
shipments[1][seller_address_line_3]stringNo
shipments[1][seller_city]stringNo
shipments[1][seller_state]stringNo
shipments[1][seller_postcode]stringNo
shipments[1][seller_country_iso]stringNo
shipments[1][full_pallet]int (Length 2)No
shipments[1][half_pallet]int (Length 2)No
shipments[1][quarter_pallet]int (Length 2)No
shipments[1][seller_documents]ArrayNoArray of KYC documents
shipments[1][parcel][0][weight]ArrayYesWeight of the parcel. it will send in array Like
parcel[0][weight] : 5
shipments[1][parcel][0][height]ArrayYesHeight of the parcel. it will send in array Like
parcel[0][height] : 10
shipments[1][parcel][0][width]ArrayYesWidth of the parcel. it will send in array Like
parcel[0][width] : 10
shipments[1][parcel][0][length]ArrayYesLength of the parcel. it will send in array Like
parcel[0][length] 10
shipments[1][parcel][0][itemvalue]ArrayNoItem value of the parcel. it will send in array Like
parcel[0][itemvalue]: 10
shipments[2][sender_country_iso]string (2)YesSender country iso code
shipments[2][service_code]string (9)YesThis is code of the Service that we are using
shipments[2][order_reference]string (40)YesThis is order reference number
shipments[2][reference]string (40)NoThis is reference for your shipment
shipments[2][sender_contact]string (40)YesName of the Sender
shipments[2][sender_email]string (45)NoEmail of the Sender
shipments[2][sender_company]string (25)NoCompany Name of the Sender
shipments[2][sender_name]string (25)NoName of the Sender
shipments[2][sender_address_line_1]string (30)YesAddress 1 of the sender
shipments[2][sender_address_line_2]string (30)NoAddress 2 of the sender
shipments[2][sender_address_line_3]string (30)NoAddress 3 of the sender
shipments[2][sender_city]string (25)YesCity of the sender
shipments[2][sender_state]string (25)NoState of the sender
shipments[2][sender_postcode]string (10)YesPostcode of the city of
shipments[2][sender_telephone]string (17)NoPhone Number of the sender
shipments[2][receiver_country_iso]string (2)YesReceiver country iso code (2)
shipments[2][receiver_email]string (45)NoEmail of the receiver
shipments[2][receiver_company]string (25)NoCompany Name of the receiver
shipments[2][receiver_contact]string (50)YesName of the receiver
shipments[2][receiver_address_line_1]string (40)YesAddress 1 of the receiver
shipments[2][receiver_address_line_2]string (40)NoAddress 2 of the receiver
shipments[2][receiver_address_line_3]string (40)NoAddress 3 of the receiver
shipments[2][receiver_city]string (25)YesCity of the receiver
shipments[2][receiver_state]string (25)NoState of the receiver
shipments[2][receiver_postcode]string (10)YesPostcode of the city of receiver
shipments[2][receiver_telephone]string (17)NoPhone Number of the receiver
shipments[2][value]Int (12)NoValue of shipped goods
shipments[2][shipment_type]stringNoPossible 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
shipments[2][collection_date]dateNoOnly for collection type shipment
Date format should be dd-mm-yyyy
shipments[2][collection_start_time]timeNoOnly for collection type shipment
Time format should be in 24 hours format like 13:30
shipments[2][collection_end_time]timeNoOnly for collection type shipment
Time format should be in 24 hours format like 13:30
shipments[2][currency]string (3)NoCurrency iso code
shipments[2][item_type]string (60)NoType of Consignment
shipments[2][Notes]stringNoAny Notes that sender adds for the Consignment
shipments[2][description]string (30)YesAny description that sender adds for the Consignment
shipments[2][eori_number]string (20)No
shipments[2][vat_number]string (20)No
shipments[2][ioss_number]string (20)No
shipments[2][seller_name]stringNo
shipments[2][seller_company]stringNo
shipments[2][seller_email]stringNo
shipments[2][seller_phone]stringNo
shipments[2][seller_address_line_1]stringNo
shipments[2][seller_address_line_2]stringNo
shipments[2][seller_address_line_3]stringNo
shipments[2][seller_city]stringNo
shipments[2][seller_state]stringNo
shipments[2][seller_postcode]stringNo
shipments[2][seller_country_iso]stringNo
shipments[2][full_pallet]int (Length 2)No
shipments[2][half_pallet]int (Length 2)No
shipments[2][quarter_pallet]int (Length 2)No
shipments[2][seller_documents]ArrayNoArray of KYC documents
shipments[2][parcel][0][weight]ArrayYesWeight of the parcel. it will send in array Like
shipments[2][parcel][0][weight] 5
shipments[2][parcel][0][height]ArrayYesHeight of the parcel. it will send in array Like
shipments[2][parcel][0][height] 10
shipments[2][parcel][0][width]ArrayYesWidth of the parcel. it will send in array Like
shipments[2][parcel][0][width] 10
shipments[2][parcel][0][length]ArrayYesLength of the parcel. it will send in array Like
shipments[2][parcel][0][length] 10
shipments[2][parcel][0][itemvalue]ArrayNoItem value of the parcel. it will send in array Like
shipments[2][parcel][0][itemvalue]: 10
shipments[2][parcel][0][items][0][item_description]ArrayNoItem description of the items inside a parcel. it will send in array Like shipments[2][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”,
shipments[2][parcel][0][items][0][no_of_items]ArrayNoSKU or product url of items inside the parcel. it will send in array Like shipments[2][parcel][0][items][0][no_of_items]: 1,
shipments[2][parcel][0][items][0][item_value]ArrayNoValue of items inside a parcel. it will send in array Like shipments[2][parcel][0][items][0][item_value]: 1,
shipments[2][parcel][0][items][0][weight]ArrayNoWeight of items inside a parcel. it will send in array Like shipments[2][parcel][0][items][0][weight]: 0.750,
shipments[2][parcel][0][items][0][tariff_No]ArrayNoTariff of items inside a parcel. it will send in array Like shipments[2][parcel][0][items][0][tariff_No]: TARIFF1,
shipments[2][parcel][0][items][0][hscode]ArrayNoHscode of items inside a parcel. it will send in array Like shipments[2][parcel][0][items][0][hscode]: hscode,
shipments[2][parcel][0][items][0][manufacture_country_iso]ArrayNoManufacture country ISO of items inside a parcel. it will send in array Like shipments[2][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.