Welcome to Parcel Courier Service

Manage your shipments, track parcels, create AWB bookings, and access courier tools from your dashboard.

BALANCE : 0.00 INR
ADD TO WALLET
SHIP&SHOP

SHOP & SHIP API INTEGRATION DOCUMENT V1.1

SHOP & SHIP WORLD

BY

SHOP & SHIP WORLD PRIVATE LIMITED

www.shopshipworld.com

Sales Email: support@shopshipworld.com

Support Email: help@shopshipworld.com

API Authorization

The Shop & Ship API supports bearer token authentication method to authorize your application API requests.

API Authorization Details

Following are the required inputs to the request.

Example

POST : https://shopshipworld.com/api/get_token

Request:


{
   "company_id": 8,
   "email": "support@shopshipworld.com",
   "password": "123456"
}

CURL Example +

Request:


curl --location --request POST 'https://shopshipworld.com/api/get_token' \

--header 'Content-Type: application/json' \

--data-raw '{

   "company_id": 8,

   "email": "support@shopshipworld.com",

   "password": "123456"

}'

PHP Example ➕
Python Example ➕
Ruby Example ➕

Label API

Label API service allows you to create shipment. Use the Bearer Token header and pass the token obtained from authorization API.

Label API Details

Following are the required inputs to the request.

Shipment details

Field Type Required? Description
tracking_no String Y Alphanumeric string
reference_name String N Reference Name
customer_id Integer Y Customer ID from authorization API response
origin_code String Y Country code OR Pin Code
product_code String Y Shipment product code
destination_code String Y Country code OR Pin Code
booking_date String Y YYYY-MM-DD format
booking_time String Y HH:MM:SS format
pcs String Y Total number of pieces
shipment_value Decimal Y Overall shipment value
shipment_value_currency String Y Shipment currency E.g. INR, USD, GBP
actual_weight Decimal Y Shipment weight in KG
shipment_invoice_no String Y Shipment invoice number
shipment_invoice_date String Y YYYY-MM-DD format date
shipment_content String Y Shipment description
remark String Optional Shipment remarks
entry_type Integer Y Entry type default 2
api_service_code String Y Available service code
new_docket_free_form_invoice String Conditional Required for NON DOC shipment
free_form_invoice_type_id Int Conditional Required if invoice enabled
free_form_currency Integer Conditional Invoice currency required
terms_of_trade String Conditional CFR, CIF, CPT, DAP etc.
free_form_note_master_code String Conditional Gift/Sample etc.
docket_items Array Y Details provided below
free_form_line_items Array Conditional Invoice line item details
kyc_details Array Conditional Required if KYC mandatory
dhl_otp String Conditional Required if DHL label
dhl_service String Conditional DHL service code

Shipper Details

Field Type Required? Description
shipper_name String Y Shipper name
shipper_company_name String Y Shipper company name
shipper_contact_no String Y Shipper contact no, It will be a mobile OR phone number.
shipper_email String Y Shipper email address
shipper_address_line_1 String Y Shipper address line 1
shipper_address_line_2 String Y Shipper address line 2
shipper_address_line_3 String Optional Shipper address line 3
shipper_city String Y Shipper city
shipper_state String Y Shipper state Code OR Name
shipper_country String Y 2 letter country code.
shipper_zip_code String Y Shipper zip code
shipper_gstin_type String Y Aadhaar Number, Authorization Letter, Citizenship Number, Consignee Id, DRIVING LICENCE, EORI, GSTIN (Diplomats), GSTIN (Govt.), GSTIN (Normal), IEC Certificate, National ID Number, NCN, NTN, Others, PAN Number, Passport Number, PNIC NUMBER, TAN Number, TRN NO, VAT, Voter Id
shipper_gstin_no String Y Shipper GSTIN number as per shipper_gstin_type

Consignee Details

Field Type Required? Description
consignee_name String Y Consignee name
consignee_company_name String Y Consignee company name
consignee_contact_no String Y Consignee contact no, It will be a mobile OR phone number.
consignee_email String Y Consignee email address
consignee_address_line_1 String Y Consignee address 1
consignee_address_line_2 String Y Consignee address 2
consignee_address_line_3 String Optional Consignee address 3
consignee_city String Y Consignee city
consignee_state String Y Consignee state Code OR Name
consignee_country String Y 2 letter country code.
consignee_zip_code String Y Consignee zip code
consignee_gstin_type String Optional Aadhaar Number, Authorization Letter, Citizenship Number, Consignee Id, DRIVING LICENCE, EORI, GSTIN (Diplomats), GSTIN (Govt.), GSTIN (Normal), IEC Certificate, National ID Number, NCN, NTN, Others, PAN Number, Passport Number, PNIC NUMBER, TAN Number, TRN NO, VAT, Voter Id
consignee_gstin_no String Optional Consignee GSTIN number as per consignee_gstin_type

Pickup Address Details

Field Type Required? Description
pickup_request int Optional 1 - for pickup YES : 2 - for pickup NO
pickup_address_code String Optional Pickup Address code
pickup_address_name String Optional Pickup Address name
pickup_address_contact_no String Optional Pickup Address contact no, It will be a mobile OR phone number.
pickup_address_email String Optional Pickup Address email address
pickup_address_address_line_1 String Optional Pickup Address address 1
pickup_address_address_line_2 String Optional Pickup Address address 2
pickup_address_address_line_3 String Optional Pickup Address address 3
pickup_address_city String Optional Pickup Address city
pickup_address_state String Optional Pickup Address state Code OR Name
pickup_address_country String Optional 2 letter country code.
pickup_address_zip_code String Optional Pickup Address zip code
pickup_address_gstin_type String Optional Aadhaar Number, Authorization Letter, Citizenship Number, Consignee Id, DRIVING LICENCE, EORI, GSTIN (Diplomats), GSTIN (Govt.), GSTIN (Normal), IEC Certificate, National ID Number, NCN, NTN, Others, PAN Number, Passport Number, PNIC NUMBER, TAN Number, TRN NO, VAT, Voter Id
pickup_address_gstin_no String Optional Pickup Address GSTIN number as per pickup_address_gstin_type

MULTIPLE INVOICE DETAILS

Field Type Required? Description
mul_invoice_date date Y YYYY-MM-DD format date E.g. 2022-09-02
mul_invoice_no String Y INV2346
mul_order_no String Y ORD234
mul_currency String Y Shipment currency E.g. INR, USD, GBP
mul_invoice_amount String Y INVOICE AMOUNT E.g. 10.0
mul_eway_bill String Y EWAY2345

Docket Items

Field Type Required? Description
actual_weight Decimal Y Item actual weight in KG. E.g 5.00
length Decimal Y Item length in CM
width Decimal Y Item width in CM
height Decimal Y Item height in CM
number_of_boxes Integer Y Number of boxes

shipment invoice Line Items

Field Type Required? Description
total Decimal Y Total = shipment invoice line item rate x shipment invoice line item no_of_packages
no_of_packages Integer Y No. of packages is quantity
box_no String Y Box no item
rate Decimal Y Rate per line item
hscode String Y Valid HS code line item E.g 17049020
description String Y Description of item
unit_of_measurement String Y Measurement unit of item E.g PCs
unit_weight Decimal Y Weight of item in KG
igst_amount Decimal Y IGST amount of item E.g 10.0
Full JSON Request Example ➕
Advanced CURL Request Example ➕
Advanced PHP Request Example ➕
Advanced Python Request Example ➕
Advanced Ruby Request Example ➕

Available Service

Service Name Service Code api_service_code

Available Currency

Currency Code
AFN
ALL
DZD
AOA
ARS
AMD
AWG
AUD
AZN
BSD
BHD
BDT
BBD
BYR
BZD
BMD
BTN
BOB
BAM
BWP
BRL
GBP
BND
BGN
MMK
BIF
KHR
CAD
CVE
KYD
XAF
XPF
CLP
CNY
COP
KMF
CDF
CRC
HRK
CUC
CUP
CZK
DKK
DJF
DOP
XCD
EGP
ERN
ETB
EUR
FKP
FJD
GMD
GEL
GHS
GIP
GTQ
GGP
GNF
GYD
HTG
HNL
HKD
HUF
ISK
INR
IDR
IRR
IQD
ILS
JMD
JPY
JOD
KZT
KES
KWD
KGS
LAK
LBP
LSL
LRD
LYD
MOP
MKD
MGA
MWK
MYR
MVR
MRO
MUR
MXN
MDL
MNT
MAD
MZN
NAD
NPR
ANG
TWD
NZD
NIO
NGN
KPW
NOK
OMR
PKR
PAB
PGK
PYG
PEN
PHP
PLN
QAR
RON
RUB
RWF
SHP
WST
STD
SAR
RSD
SCR
SLL
SGD
SBD
SOS
ZAR
NZD
NIO
NGN
KPW
NOK
OMR
PKR
PAB
PGK
PYG
PEN
PHP
PLN
QAR
RON
RUB
RWF
SHP
WST
STD
SAR
RSD
SCR
SLL
SGD
SBD
SOS
ZAR
KRW
SSP
LKR
SDG
SRD
SZL
SEK
CHF
SYP
TJS
TZS
THB
TOP
TTD
TND
TRY
TMT
UGX
UAH
AED
USD
UYU
UZS
VEF
XOF
YER
ZMW

Available Domestic Location ➕

Location Name Location Code

Available International Location ➕

Location Name Location Code
AFGHANISTANAF
ALBANIAAL
ALGERIADZ
AMERICAN SAMOAAS
ANDORRAAD
ANGOLAAO
ANGUILLAAI
ANTIGUAAG
ARGENTINA AR
ARMENIA AM
ARUBA AW
AUSTRALIA AU
AUSTRIA AT
AZERBAIJAN AZ
BAHAMAS BS
BAHRAIN BH
BANGLADESH BD
BARBADOS BB
BELARUS BY
BELGIUM BE
BELIZE BZ
BENIN BJ
BERMUDA BM
BHUTAN BT
BOLIVIA BO
BONAIRE BQ
BONAIRE XB
BOSNIA BX
BOSNIA AND HERZEGOVINA BA
BOTSWANA BW
BRAZIL BR
BRUNEI BN
BULGARIA BG
BURKINA FASO BF
BURUNDI BI
CAMBODIA KH
CAMEROON CM
CONGO CG
CONGO, THE DEMOCRATIC REPUBLIC CD
COOK ISLANDS CK
COSTA RICA CR
COTE DIVOIRE CI
CROATIA HR
CUBA CU
CURACAO XC
CYPRUS CY
CZECH REPUBLIC CZ
DENMARK DK
DJIBOUTI DJ
DOMINICA DM
DOMINICAN REPUBLIC DO
EAST TIMOR TL
ECUADOR EC
EGYPT EG
EL SALVADOR SV
EQUATORIAL GUINEA GQ
ERITREA ER
ESTONIA EE
ETHIOPIA ET
FALKLAND ISLANDS FK
FAROE ISLANDS FO
FIJI FJ
FINLAND FI
FRANCE FR
FRENCH GUYANA GF
FRENCH POLYNESIA PF
GABON GA
GAMBIA GM
GEORGIA GE
GERMANY DE
GHANA GH
GIBRALTAR GI
GREECE GR
GREENLAND GL
GRENADA GD
GUADELOUPE GP
GUAM GU
GUATEMALA GT
GUERNSEY GG
GUINEA REPUBLIC GN
GUINEA-BISSAU GW
GUYANA GY
HAITI HT
HONDURAS HN
HONG KONG HK
HUNGARY HU
ICELAND IS
INDIA IN
INDONESIA ID
IRAN (ISLAMIC REPUBLIC OF) IR
IRAQ IQ
IRELAND IE
ISRAEL IL
ITALY IT
JAMAICA JM
JAPAN JP
JERSEY JE
JORDAN JO
KAZAKHSTAN KZ
KENYA KE
KIRIBATI KI
KOREA SOUTH KR
KOREA, THE D.P.R OF KP
KOSOVO KV
KUWAIT KW
KYRGYZSTAN KG
LAOS LA
LATVIA LV
LEBANON LB
LESOTHO LS
LIBERIA LR
LIBYA LY
LIECHTENSTEIN LI
LITHUANIA LT
LUXEMBOURG LU
MACAU MO
MACEDONIA MK
MADAGASCAR MG
MALAWI MW
MALAYSIA MY
MALDIVES MV
MALI ML
MALTA MT
MARSHALL ISLANDS MH
MARTINIQUE MQ
MAURITANIA MR
MAURITIUS MU
MAYOTTE YT
MEXICO MX
MICRONESIA FM
MOLDOVA MD
MONACO MC
MONGOLIA MN
MONTENEGRO, REPUBLIC OF ME
MONTSERRAT MS
MOROCCO MA
MOZAMBIQUE MZ
MYANMAR MM
NAMIBIA NA
NAURU NR
NEPAL NP
NETHERLAND ANTILLES AN
NETHERLANDS NL
NEVIS XN
NEW CALEDONIA NC
NEW ZEALAND NZ
NICARAGUA NI
NIGER NE
NIGERIA NG
NIUE NU
NORFOLK ISLAND NF
NORWAY NO
OMAN OM
PAKISTAN PK
PALAU PW
PALESTINE AUTHORITY PS
PANAMA PA
PAPUA NEW GUINEA PG
PARAGUAY PY
PERU PE
PHILIPPINES PH
POLAND PL
PORTUGAL PT
PUERTO RICO PR
QATAR QA
REUNION ISLAND RE
ROMANIA RO
RUSSIA RU
RWANDA RW
SAINT HELENA SH
SAINT LUCIA LC
SAIPAN MP
SAMOA WS
SAN MARINO SM
SAO TOME AND PRINCIPE ST
SAUDI ARABIA SA
SENEGAL SN
SERBIA RS
SEYCHELLES SC
SIERRA LEONE SL
SINGAPORE SG
SLOVAKIA SK
SLOVENIA SI
SOLOMON ISLANDS SB
SOMALIA SO
SOMALILAND, REP OF (NORTH SOMALIA) XS
SOUTH AFRICA ZA
SOUTH SUDAN SS
SPAIN ES
SRI LANKA LK
ST KITTS & NEVIS KN
ST MAARTEN SX
ST VICENT AND THE GRENADINES VC
ST. BARTHELEMY XY
ST. EUSTATIUS XE
ST. MAARTEN XM
SUDAN SD
SURINAME SR
SWAZILAND SZ
SWEDEN SE
SWITZERLAND CH
SYRIA SY
TAIWAN TW
TAJIKISTAN TJ
TANZANIA TZ
THAILAND TH
TOGO TG
TONGA TO
TRINIDAD AND TOBAGO TT
TUNISIA TN
TURKEY TR
TURKMENISTAN TM
TURKS AND CAICOS ISLANDS TC
TUVALU TV
UGANDA UG
UKRAINE UA
UNITED ARAB EMIRATES AE
UNITED KINGDOM GB
UNITED STATES OF AMERICA US
URUGUAY UY
UZBEKISTAN UZ
VANUATU VU
VATICAN CITY STATE VA
VENEZUELA VE
VIETNAM VN
VIRGIN ISLANDS (BRITISH) VG
VIRGIN ISLANDS (US) VI
WALLIS AND FUTUNA ISLANDS WF
YEMEN YE
ZAMBIA ZM
ZIMBABWE ZW
Available Service ➕
Available Currency ➕
Available International Location ➕
Scroll to Top