{"info":{"_postman_id":"b39fd2c2-59e0-4bdd-b66e-f19ed81b0532","name":"IQ Hybrid API Docs","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"24454148","collectionId":"b39fd2c2-59e0-4bdd-b66e-f19ed81b0532","publishedId":"2sA3dsmZ1z","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-10-16T05:19:09.000Z"},"item":[{"name":"Extra System Information","item":[{"name":"Warehouses","item":[],"id":"8c42b02e-c324-4243-aad6-a171905cfa88","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Name
IQBHR01	IQBHR01
IQKSA01	IQKSA01
IQKSA02	IQKSA02
IQKWT01	IQKWT01
IQKWT02	IQKWT02
IQWH01	IQ UAE WAREHOUSE
IQOMN01	IQ OMN Warehouse
IQWHFZ1	IQWHFZ1
IQQAT01	IQ QTR WAREHOUSE
IQBHR02	IQBHR02
IQWHFZ2	IQWHFZ2

","_postman_id":"8c42b02e-c324-4243-aad6-a171905cfa88"},{"name":"Order Status","item":[],"id":"bbb47a30-0cdf-4124-bc27-b379c90b9512","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

ID	Title
1300	Received
1310	Process Failed
1320	Pending
1330	Pending Audit
1340	On Hold
1350	Pending Assignment
1360	Assignment Failed
1370	Sync Failed
1375	Assigned
1380	Validation Failed
1385	Validated
10	Confirmed
11	Partially Allocated
12	Allocated
15	Split
20	Partially Picked
30	Picked
40	Partially Packed
50	Packed
54	Under clearance

","_postman_id":"bbb47a30-0cdf-4124-bc27-b379c90b9512"},{"name":"SKU Types","item":[],"id":"077a7af1-1ee0-44c4-9075-c3824cd74110","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Label
Regular
Irregular
Bulky
Fragile
Bundle
Subscription
Virtual
XDOCK
Dangerous Goods

","_postman_id":"077a7af1-1ee0-44c4-9075-c3824cd74110"},{"name":"Order Types","item":[],"id":"a989f090-b006-4197-bf52-2ffc1ecc0bc8","description":"

Code	Label
BOX	Packaging
ECOM	Custom
OUTCG
OUTPF
OUTXS	Fulfillment
OUTXS2	Bulky
RT	Return to Vendor
SO	Fulfillment
XDOCK	Cross Dock
AMZSS	AMAZON Self Ship
NNES	Noon Easy Ship
EPKUP	self pick for orders
TT	warehouse transfer
FBA	fulfilled by amazon
FBN	fulfilled by noon
RVP	reverse pickup
XSDOCK	cross dock with SKU
FMXDOCK	crossdock with first mile pickup 3pl
INT	Internal pullout for internal use
FMXDOCKNT	crossdock , international delivery with 3pl Mile pickup
PULL
FLUSH
KT
B2B	B2B Orders
pickup	Pickup
Reverse	Pick Reverse Pick
Refund	Refund
Collection	Collection
B2BM
FLUSH	FLUSH

","_postman_id":"a989f090-b006-4197-bf52-2ffc1ecc0bc8"},{"name":"Countries","item":[],"id":"d8c218d9-4b20-464a-b160-0aac2bca9a27","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Title	Code	shortName
Afghanistan	AFG	AF
Albania	ALB	AL
Algeria	ALG	DZ
American Samoa		AS
Andorra	AND	AD
Angola	ANG	AO
Anguilla		AI
Antarctica		AQ
Antigua And Barbuda	ATG	AG
Argentina	ARG	AR
Armenia	ARM	AM
Aruba		AW
Australia	AUS	AU
Austria	AUT	AT
Azerbaijan	AZE	AZ
Bahamas The	BAH	BS
Bahrain	BHR	BH
Bangladesh	BAN	BD
Barbados	BRB	BB
Belarus	BLR	BY
Belgium	BEL	BE
Belize	BLZ	BZ
Benin	BEN	BJ
Bermuda		BM
Bhutan	BHU	BT
Bolivia	BOL	BO
Bosnia and Herzegovina	BIH	BA
Botswana	BOT	BW
Bouvet Island		BV
Brazil	BRA	BR
British Indian Ocean Territory		IO
Brunei	BRU	BN
Bulgaria	BUL	BG
Burkina Faso	BFA	BF
Burundi	BDI	BI
Cambodia	CAM	KH
Cameroon	CMR	CM
Canada	CAN	CA
Cape Verde	CPV	CV
Cayman Islands		KY
Central African Republic	CTA	CF
Chad	CHA	TD
Chile	CHI	CL
China	CHN	CN
Christmas Island		CX
Cocos (Keeling) Islands		CC
Colombia	COL	CO
Comoros	COM	KM
Republic Of The Congo	CGO	CG
Democratic Republic Of The Congo	COD	CD
Cook Islands		CK
Costa Rica	CRC	CR
Cote D'Ivoire (Ivory Coast)	CIV	CI
Croatia (Hrvatska)	CRO	HR
Cuba	CUB	CU
Cyprus	CYP	CY
Czech Republic	CZE	CZ
Denmark	DEN	DK
Djibouti	DJI	DJ
Dominica	DMA	DM
Dominican Republic	DOM	DO
East Timor		TP
Ecuador	ECU	EC
Egypt	EGY	EG
El Salvador	SLV	SV
Equatorial Guinea	EQG	GQ
Eritrea	ERI	ER
Estonia	EST	EE
Ethiopia	ETH	ET
External Territories of Australia		XA
Falkland Islands		FK
Faroe Islands		FO
Fiji Islands	FIJ	FJ
Finland	FIN	FI
France	FRA	FR
French Guiana	GUF	GF
French Polynesia		PF
French Southern Territories		TF
Gabon	GAB	GA
Gambia The	GAM	GM
Georgia	GEO	GE
Germany	GER	DE
Ghana	GHA	GH
Gibraltar		GI
Greece	GRE	GR
Greenland		GL
Grenada	GRN	GD
Guadeloupe		GP
Guam		GU
Guatemala	GUA	GT
Guernsey and Alderney		XU
Guinea	GUI	GN
Guinea-Bissau	GNB	GW
Guyana	GUY	GY
Haiti	HAI	HT
Heard and McDonald Islands		HM
Honduras	HON	HN
Hong Kong	HKG	HK
Hungary	HUN	HU
Iceland	ISL	IS
India	IND	IN
Indonesia	IDN	ID
Iran	IRN	IR
Iraq	IRQ	IQ
Ireland	IRL	IE
Israel	ISR	IL
Italy	ITA	IT
Jamaica	JAM	JM
Japan	JPN	JP
Jersey		XJ
Jordan	JOR	JO
Kazakhstan	KAZ	KZ
Kenya	KEN	KE
Kiribati	KIR	KI
Korea North	PRK	KP
Korea South	KOR	KR
Kuwait	KWT	KW
Kyrgyzstan	KGZ	KG
Laos	LAO	LA
Latvia	LVA	LV
Lebanon	LBN	LB
Lesotho	LES	LS
Liberia	LBR	LR
Libya	LBY	LY
Liechtenstein	LIE	LI
Lithuania	LTU	LT
Luxembourg	LUX	LU
Macau S.A.R.	MAC	MO
Macedonia	MKD	MK
Madagascar	MAD	MG
Malawi	MWI	MW
Malaysia	MAS	MY
Maldives	MDV	MV
Mali	MLI	ML
Malta	MLT	MT
Man (Isle of)		XM
Marshall Islands	MHL	MH
Martinique		MQ
Mauritania	MTN	MR
Mauritius	MRI	MU
Mayotte	MYT	YT
Mexico	MEX	MX
Micronesia	FSM	FM
Moldova	MDA	MD
Monaco	MON	MC
Mongolia	MNG	MN
Montserrat		MS
Morocco	MAR	MA
Mozambique	MOZ	MZ
Myanmar	MYA	MM
Namibia	NAM	NA
Nauru	NRU	NR
Nepal	NEP	NP
Netherlands Antilles		AN
Netherlands The	NED	NL
New Caledonia		NC
New Zealand	NZL	NZ
Nicaragua	NCA	NI
Niger	NIG	NE
Nigeria	NGA	NG
Niue		NU
Norfolk Island		NF
Northern Mariana Islands		MP
Norway	NOR	NO
Oman	OMN	OM
Pakistan	PAK	PK
Palau	PLW	PW
Palestinian Territory Occupied		PS
Panama	PAN	PA
Papua new Guinea	PNG	PG
Paraguay	PAR	PY
Peru	PER	PE
Philippines	PHI	PH
Pitcairn Island		PN
Poland	POL	PL
Portugal	POR	PT
Puerto Rico	PRI	PR
Qatar	QAT	QA
Reunion	REU	RE
Romania	ROU	RO
Russia	RUS	RU
Rwanda	RWA	RW
Saint Helena		SH
Saint Kitts And Nevis	SKN	KN
Saint Lucia	LCA	LC
Saint Pierre and Miquelon		PM
Saint Vincent And The Grenadines	VIN	VC
Samoa	SAM	WS
San Marino	SMR	SM
Sao Tome and Principe	STP	ST
Saudi Arabia	KSA	SA
Senegal	SEN	SN
Serbia	SRB	RS
Seychelles	SEY	SC
Sierra Leone	SLE	SL
Singapore	SIN	SG
Slovakia	SVK	SK
Slovenia	SVN	SI
Smaller Territories of the UK		XG
Solomon Islands	SOL	SB
Somalia	SOM	SO
South Africa	RSA	ZA
South Georgia		GS
South Sudan		SS
Spain	ESP	ES
Sri Lanka	SRI	LK
Sudan	SUD	SD
Suriname	SUR	SR
Svalbard And Jan Mayen Islands		SJ
Swaziland	SWZ	SZ
Sweden	SWE	SE
Switzerland	SUI	CH
Syria	SYR	SY
Taiwan	TWN	TW
Tajikistan	TJK	TJ
Tanzania	TAN	TZ
Thailand	THA	TH
Togo	TOG	TG
Tokelau		TK
Tonga	TGA	TO
Trinidad And Tobago	TRI	TT
Tunisia	TUN	TN
Turkey	TUR	TR
Turkmenistan	TKM	TM
Turks And Caicos Islands		TC
Tuvalu	TUV	TV
Uganda	UGA	UG
Ukraine	UKR	UA
United Arab Emirates	UAE	AE
United Kingdom	GBR	GB
United States	USA	US
United States Minor Outlying Islands		UM
Uruguay	URU	UY
Uzbekistan	UZB	UZ
Vanuatu	VAN	VU
Vatican City State (Holy See)	VAT	VA
Venezuela	VEN	VE
Vietnam	VIE	VN
Virgin Islands (British)		VG
Virgin Islands (US)		VI
Wallis And Futuna Islands		WF
Western Sahara		EH
Yemen	YEM	YE
Yugoslavia		YU
Zambia	ZAM	ZM
Zimbabwe	ZIM	ZW
Aruba	ABW	AW
Isle Of Man		IM
Guernsey		GG

","_postman_id":"d8c218d9-4b20-464a-b160-0aac2bca9a27"},{"name":"ASN Vehicle Types","item":[],"id":"8cc1550f-1746-4024-bba5-0fb50ea89a57","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Label	Description
3-10ton temp control truck
3-10ton dry truck
3-10ton open truck
Temp control van
Dry van
Car
Bike
20ft container
40ft container
20ft chiller container
40ft chiller container

","_postman_id":"8cc1550f-1746-4024-bba5-0fb50ea89a57"},{"name":"ASN Types","item":[],"id":"00eb655e-f04c-4f1c-8e79-5c0bd5962eb7","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Label	Description
VPO
CR
INXS
DR
RR

","_postman_id":"00eb655e-f04c-4f1c-8e79-5c0bd5962eb7"}],"id":"addf43c4-fc4d-4c58-92c6-376d8a97f165","_postman_id":"addf43c4-fc4d-4c58-92c6-376d8a97f165","description":""},{"name":"Orders","item":[{"name":"Get","id":"cbd0067c-7303-42b2-b580-de134554e6d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{token}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"page\": 1,\n \"per_page\": 2,\n \"include_skus\": true,\n \"include_status_history\": false,\n \"client_references\":[\"ref1\",\"ref2\"],\n \"carriers\":[\"car1\",\"car2\"],\n \"awb\":[\"awb1\",\"awb2\"],\n \"status\":[\"Confirmed\",\"Pending Audit\"],\n \"payment_types\":[\"COD\",\"PREPAID\"],\n \"warehouses\":[\"WRH1\",\"WRH2\"],\n \"countries\":[\"KSA\",\"UAE\"],\n \"skus\":[\"sku1\",\"sku2\"],\n \"order_creation_date_range\":[\"12-12-2023 12:12:12\",\"15-12-2023 12:12:12\"],\n \"order_shipped_date_range\":[\"12-12-2023 12:12:12\",\"15-12-2023 12:12:12\"],\n \"order_delivered_date_range\":[\"12-12-2023 12:12:12\",\"15-12-2023 12:12:12\"]\n}","options":{"raw":{"language":"json"}}},"url":"BASE_URL/api/v3/orders","description":"

Body description:

Attribute	Example	Type	Validation	Description
per_page	10	Numeric	Optional	The number of results per page. Defaults to 50. If include_status_history is set to true and per_page is greater than 20 then it will be set to 10.
page	1	Numeric	Required	The page number.
include_skus	true	Boolean	Optional	Include related skus of the order. Possible values: true, false.
include_status_history	true	Boolean	Optional	Include status history for the orders. Possible values: true, false.
client_references	[ \"ref1\",\"ref2\" ]	Array	Optional	An array of client references. Only orders with the specified client references will be returned.
carriers	[\"car1\",\"car2\"]	Array	Optional	An array of carrier IDs. Only orders with the specified carrier IDs will be returned.
awb	[\"awb1\",\"awb2\"]	Array	Optional	An array of AWB numbers. Only orders with the specified AWB numbers will be returned.
status	[\"Confirmed\",\"Pending Audit\"]	Array	Optional	An array of status labels. Only orders with the specified statuses will be returned.
payment_types	[\"COD\",\"PREPAID\"]	Array	Optional	An array of payment type system codes. Only orders with the specified payment type system codes will be returned.
warehouses	[\"WRH1\",\"WRH2\"]	Array	Optional	An array of warehouse system codes. Only orders with the specified warehouse system codes will be returned.
countries	[\"KSA\",\"UAE\"]	Array	Optional	An array of country ISO3 codes. Only orders with the specified country ISO3 codes will be returned.
skus	[\"SKU1\",\"SKU2\"]	Array	Optional	An array of SKU codes. Only orders that contain the specified SKUs will be returned.
order_creation_date_range	[\"12-12-2023 12:12:12\",\"15-12-2023 12:12:12\"]	Array	Optional	An array of two timestamps representing the start and end dates of the order creation date range. Only orders that were created within the specified date range will be returned.
order_shipped_date_range	[\"12-12-2023 12:12:12\",\"15-12-2023 12:12:12\"]	Array	Optional	An array of two timestamps representing the start and end dates of the order shipped date range. Only orders that were shipped within the specified date range will be returned.
order_delivered_date_range	[\"12-12-2023 12:12:12\",\"15-12-2023 12:12:12\"]	Array	Optional	An array of two timestamps representing the start and end dates of the order delivered date range. Only orders that were delivered within the specified date range will be returned.

Response description:

Attribute	Type	Description
success	Boolean	Status of request.
pagination	Object	Pagination data.
pagination.per_page	integer	The number of items to be shown per page. Default 50
pagination.current_page	integer	The current page number. Default 1
pagination.last_page	integer	The last page number.
pagination.total	integer	The total number of rows.
applied_filters	Array	The array of applied filters.
applied_filters.client_references	string	The client references filter which are applied in the filter.
applied_filters.carriers	Array	The carriers which are applied in the filter.
applied_filters.awb	Array	The awb which are applied in the filter.
applied_filters.status	Array	The status which are applied in the filter.
applied_filters.payment_types	Array	The payment types which are applied in the filter.
applied_filters.warehouses	Array	The warehouses which are applied in the filter.
applied_filters.countries	Array	The countries which are applied in the filter.
applied_filters.skus	Array	The skus which are applied in the filter.
applied_filters.order_creation_date_range	Array	The order creation date range which is applied in the filter.
applied_filters.order_shipped_date_range	Array	The order shipped date range which is applied in the filter.
applied_filters.order_delivered_date_range	Array	The order delivered date range which is applied in the filter.
include_skus	Boolean	Include skus switch.
include_status_history	Boolean	Include status history of the order switch.
data.*.id	Numeric	The unique ID of the order.
data.*.client_reference	String	The client reference for the order.
data.*.original_order_no	String	The original order number, if available.
data.*.order_number	String	The order number.
data.*.warehouse	String	The warehouse system code for the order.
data.*.order_type	String	The type of order.
data.*.destination_type	String	The destination type for the order.
data.*.awb	String	The Airway Bill number for delivery, if available.
data.*.comment	String	Additional comments about the order.
data.*.order_description	String	Description of the order.
data.*.split_order_status	boolean	Indicates if the order is split.
data.*.price	decimal	The price of the order.
data.*.currency	String	The currency of the price.
data.*.payment_type	String	The payment type for the order.
data.*.order_creation_time	String	The timestamp when the order was created.
data.*.shipped_time	String	The timestamp when the order was shipped.
data.*.delivered_time	String	The timestamp when the order was delivered.
data.*.consignee.name	String	The name of the consignee.
data.*.consignee.phone	String	The phone number of the consignee.
data.*.consignee.mobile	String	The mobile number of the consignee.
data.*.consignee.email	String	The email address of the consignee.
data.*.address.address	String	The street address.
data.*.address.area	String	The area or locality.
data.*.address.province	String	The province or state.
data.*.address.town	String	The town or district.
data.*.address.city	String	The city.
data.*.address.state	String	The state.
data.*.address.country	String	The country.
data.*.address.zipcode	String	The ZIP code.
data.*.address.route	String	The route or street details.
data.*.parcel.total_weight	Numeric	Total weight of the parcel.
data.*.parcel.total_volume	Numeric	Total volume of the parcel.
data.*.parcel.number_of_boxes	Numeric	Number of boxes in the parcel.
data.*.current_status.status_id	Numeric	The ID of the status at the specific point in history.
data.*.current_status.status	String	The label of the current order status.
data.*.current_status.date	String	The timestamp of the current order status.
data.*.current_status.comment	String	Comment about the current order status.
data.*.skus	Array	An array of SKUs included in the order.
data..skus..alternate_sku_name	String	Alternate name for the SKU.
data..skus..quantity	Numeric	The quantity of the SKU in the order.
data..skus..serials	Array	An array of serial objects associated with the SKU.
data..skus..serials.*.serial_number	String	The serial number of the product.
data..skus..serials.*.second_serial_number	String	A second serial number, if available.
data..skus..serials.*.scan_time	String	The timestamp when the serial number was scanned.
data.*.current_status	Array	Current status data. Only availabel if order status is not split.
data..current_status..status_id	Numeric	The ID of the status at the specific point in history.
data..current_status..status	String	The label of the status at the specific point in history.
data..current_status..date	String	The timestamp when the status change occurred.
data..current_status..comment	String	Comment or details about the status change.
data.*.status_history	Array	An array of status history objects.
data..status_history..status_id	Numeric	The ID of the status at the specific point in history.
data..status_history..status	String	The label of the status at the specific point in history.
data..status_history..date	String	The timestamp when the status change occurred.
data..status_history..comment	String	Comment or details about the status change.
data.*.split_orders	Array	Child orders in exact same format as order data array above.

","urlObject":{"path":["api","v3","orders"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"cbd0067c-7303-42b2-b580-de134554e6d4"},{"name":"Create","id":"c6da2875-4135-4908-8bb9-d276eb29105c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{token}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client_reference\": \"TEST10002\",\n \"warehouse\":\"WRH1\",\n \"delivery_no_generate\": true,\n \"order_type\": \"OUTXS\",\n \"order_status\":\"Confirmed\",\n \"carrier\":\"ALMA\",\n \"note\": \"This is the pickup address test notes.\",\n \"delivery_duty_type\": \"DDU\",\n \"payment_type\": \"PREPAID\",\n \"currency\": \"AED\",\n \"shipping_price\": 20,\n \"total_tax\": 0,\n \"tax_percentage\": 0,\n \"total_discount\": 0,\n \"subtotal\": 0,\n \"cod_amount\": 0,\n \"total_price\": 220,\n \"total_declared_amount\": 0,\n \"skus\": [\n {\n \"code\": \"973-001-000\",\n \"description\": \"Shirt Size S\",\n \"quantity\": \"1\",\n \"price\": 1,\n \"discounted_price\": 0,\n \"store_code\":\"test\",\n \"supplierId\":\"1\",\n \"supplierAddress\":\"Address 1\",\n \"goods_price\":1,\n \"line_no\":1\n }\n ],\n \"consignee\": {\n \"name\": \"Pradeep\",\n \"surname\":\"Singh\",\n \"phone\": \"12344553445\",\n \"mobile\": \"12344553445\",\n \"email\": \"email@email.com\"\n },\n \"shipping_address\": {\n \"country\": \"AE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"area\":\"DIP2\",\n \"address_1\": \"Xyz Complex\",\n \"address_2\": \"Dubai\",\n \"postal_code\": \"00000\"\n },\n \"parcel\": {\n \"total_weight\": 0,\n \"total_volume\": 0,\n \"box_number\": 1\n },\n \"carrier_option\":\"3PL\",\n \"created_at\":\"12-12-2024\",\n \"gift_message\":\"message 1\",\n \"files\": [\n {\n \"title\": \"Shipping Label PDF 1\",\n \"url\": \"https://iqintegrate.com/images/1.png\"\n },\n {\n \"title\": \"Shipping Label PDF 2\",\n \"url\": \"https://iqintegrate.com/images/2.png\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"BASE_URL/api/v3/orders/create","description":"

Creating orders

Body description:

Attribute	Example	Type	Validation	Description
client_reference	IQF00001	String	Required Unique Without Spaces Max: 20	Client reference for order.
warehouse	TEST	String	Optional	Warehouse for the SKU.
delivery_no_generate	true	Boolean	optional	Delivery no to generate or not.
order_type	OUTXS	String	optional	Order type
order_status	Confirmed	String	optional	Order status
carrier	Carrier_Name	String	optional	Carrier name
note	This is note	String	Optional	Note for order.
delivery_duty_type	DDU	String	optional	Delivery duty type
payment_type	COD	String	COD or PREPAID	Payment type for order. Possible values: COD, PREPAID. Please, check the payment types on extra information menu.
currency	AED	String	Required	ISO3 code for the currency. Possible values: AED, USD. Please, check the currencies on extra information menu.
shipping_price	42	Numeric	Optional	Shipping price of order.
total_tax	1	Numeric	Optional	The total tax amount of order.
tax_percentage	1	Numeric	Optional	Tax percentage for the order.
total_discount	1	Numeric	Optional	Total discount for the order.
subtotal	1	Numeric	Optional	Subtotal amount for the order.
cod_amount	1	Numeric	Optional. Required if Payment type is COD	Cash on delivery amount for the order.
total_price	1900	Numeric	Required	Total price of the order.
total_declared_amount	0	Numeric	Optional	Total declared amount for the order.
carrier_option	3PL	Numeric	Optional	Carrier option for the order.
created_at	Date	Date	Optional	Order creation time.
gift_message	Test message	String	Optional	Order message
skus	[ { 'code': 'CODE1', 'quantity':1, 'price':1, 'discounted_price':1 }, ]	Array	Required	Array of SKUs for the order.
skus.*.line_no	Shirt	String	Optional	SKU line no.
skus.*.code	858936006838	String	Required	SKU code. Please, check the skus on extra information menu.
skus.*.description	Shirt	String	Required	SKU description.
skus.*.quantity	1	Numeric	Required Greater than 0	Quantity of the SKU.
skus.*.price	1	Numeric	Optional	Price of the SKU.
skus.*.discounted_price	1	Numeric	Optional	Discounted price of the SKU.
skus.*.store_code	test	String	Optional	Code of the store offering the SKU
skus.*.supplierId	1	String	Optional	Supplier ID for the SKU
skus.*.supplierAddress	Address 1	String	Optional	Supplier’s address
skus.*.goods_price	1	Float	Optional	Original goods price before discounts
consignee		Array	Required	Consignee information.
consignee.name	John	String	Required Max:191	Consignee name.
consignee.surname	Doe	String	Optional Max:191	Consignee surname.
consignee.phone	123456789	Numeric	Required	Consignee phone number.
consignee.mobile	123456789	Numeric	Required	Consignee mobile number.
consignee.email	example@email.com	String	Required Email format	Consignee email address.
shipping_address		Array	Required	Shipping address information.
shipping_address.country	USA	String	Required Min:2, Max:3	ISO2 or ISO3 name for the shipping country. Possible values: USA, ALB. Please, check the countries on extra information menu.
shipping_address.state	Aseer	String	Required Max:30	Shipping state. Possible values: Al Khobar, Aseer. Please, check the states on extra information menu.
shipping_address.city	Al Khobar	String	Required Max:30	Shipping city. Possible values: Mahayel, Al Khobar. Please, check the cities on extra information menu.
shipping_address.area	Muscat	String	Optional Max:50	Shipping area. Possible values: Muscat. Please, check the areas on extra information menu.
shipping_address.address_1	Address 1	String	Required Max:255	Shipping address line 1.
shipping_address.address_2	Address	String	Optional Max:255	Shipping address line 2.
shipping_address.postal_code	3215	String	Optional	Postal code.
files	[ { \"title\": \"Shipping Label PDF 1\", \"url\": \"https://iqintegrate.com/images/1.png\" }, ]	Array	Optional	Related file links.
files.*.title	Shipping Label PDF 1	String	Required	File title.
files.*.url	https://iqintegrate.com/images/1.png	String	Required	File link.

Response description:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
success	Boolean	Status of the request. Possible values: true, false.
code	Numeric	Response code. Possible values: 422, 400.
message	String	Response message.
client_reference	String	Client Reference

","urlObject":{"path":["api","v3","orders","create"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"c6da2875-4135-4908-8bb9-d276eb29105c"},{"name":"Bulk Create","id":"6b6d0c00-4657-43d1-9a2c-9c990173519f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{token}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orders\": [\n {\n \"client_reference\": \"TEST26\",\n \"note\": \"This is the pickup address test notes.\",\n \"payment_type\": \"PREPAID\",\n \"currency\": \"AED\",\n \"order_type\": \"OUTXS\",\n \"shipping_method\": \"SDD\",\n \"shipping_price\": 42,\n \"total_tax\": 0,\n \"tax_percentage\": 0,\n \"total_discount\": 0,\n \"subtotal\": 0,\n \"cod_amount\": 0,\n \"total_price\": 1900,\n \"warehouse\": \"TEST\",\n \"skus\": [\n {\n \"code\": \"200G\",\n \"quantity\": \"1\",\n \"price\": 1000,\n \"discounted_price\": 1000\n }\n ],\n \"consignee\": {\n \"name\": \"Vishal\",\n \"phone\": \"12344553445\",\n \"email\": \"email@email.com\"\n },\n \"shipping_address\": {\n \"country\": \"UAE\",\n \"state\": \"Abu Dhabi\",\n \"city\": \"Sharjah\",\n \"area\": \"Test\",\n \"address_1\": \"Xyz Complex\",\n \"address_2\": \"Abu Dhabi, Dubai\",\n \"postal_code\": \"3215645\"\n }\n },\n {\n \"client_reference\": \"TEST27\",\n \"note\": \"This is the pickup address test notes.\",\n \"payment_type\": \"PREPAID\",\n \"currency\": \"AED\",\n \"order_type\": \"OUTXS\",\n \"shipping_method\": \"SDD\",\n \"shipping_price\": 42,\n \"total_tax\": 0,\n \"tax_percentage\": 0,\n \"total_discount\": 0,\n \"subtotal\": 0,\n \"cod_amount\": 0,\n \"total_price\": 1900,\n \"warehouse\": \"TEST\",\n \"skus\": [\n {\n \"code\": \"200G\",\n \"quantity\": \"1\",\n \"price\": 1000,\n \"discounted_price\": 1000\n }\n ],\n \"consignee\": {\n \"name\": \"Vishal\",\n \"phone\": \"12344553445\",\n \"email\": \"email@email.com\"\n },\n \"shipping_address\": {\n \"country\": \"UAE\",\n \"state\": \"Abu Dhabi\",\n \"city\": \"Sharjah\",\n \"area\": \"Test\",\n \"address_1\": \"Xyz Complex\",\n \"address_2\": \"Abu Dhabi, Dubai\",\n \"postal_code\": \"3215645\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"BASE_URL/api/v3/orders/bulk/create","description":"

Bulk Creating orders

Body description:

Attribute	Example	Type	Validation	Description
orders.*.client_reference	IQF00001	String	Required Unique Without Spaces Max: 20	Client reference for order.
orders.*.note	This is note	String	Optional	Note for order.
orders.*.payment_type	COD	String	COD or PREPAID	Payment type for order. Possible values: COD, PREPAID. Please, check the payment types on extra information menu.
orders.*.currency	AED	String	Required	ISO3 code for the currency. Possible values: AED, USD. Please, check the currencies on extra information menu.
orders.*.shipping_price	42	Numeric	Optional	Shipping price of order.
orders.*.total_tax	1	Numeric	Optional	The total tax amount of order.
orders.*.tax_percentage	1	Numeric	Optional	Tax percentage for the order.
orders.*.total_discount	1	Numeric	Optional	Total discount for the order.
orders.*.subtotal	1	Numeric	Optional	Subtotal amount for the order.
orders.*.cod_amount	1	Numeric	Optional. Required if Payment type is COD	Cash on delivery amount for the order.
orders.*.total_price	1900	Numeric	Required	Total price of the order.
orders.*.skus	[ { 'code': 'CODE1', 'quantity':1, 'price':1, 'discounted_price':1 }, ]	Array	Required	Array of SKUs for the order.
orders..skus..code	858936006838	String	Required	SKU code. Please, check the skus on extra information menu.
orders..skus..quantity	1	Numeric	Required Greater than 0	Quantity of the SKU.
orders..skus..price	1	Numeric	Optional	Price of the SKU.
orders..skus..discounted_price	1	Numeric	Optional	Discounted price of the SKU.
orders.*.consignee		Array	Required	Consignee information.
orders.*.consignee.name	John	String	Required Max:191	Consignee name.
orders.*.consignee.phone	123456789	Numeric	Required	Consignee phone number.
orders.*.consignee.email	example@email.com	String	Required Email format	Consignee email address.
orders.*.shipping_address		Array	Required	Shipping address information.
orders.*.shipping_address.country	USA	String	Required Min:2, Max:3	ISO2 or ISO3 name for the shipping country. Possible values: USA, ALB. Please, check the countries on extra information menu.
orders.*.shipping_address.state	Aseer	String	Required Max:30	Shipping state. Possible values: Al Khobar, Aseer. Please, check the states on extra information menu.
orders.*.shipping_address.city	Al Khobar	String	Required Max:30	Shipping city. Possible values: Mahayel, Al Khobar. Please, check the cities on extra information menu.
orders.*.shipping_address.area	Muscat	String	Optional Max:50	Shipping area. Possible values: Muscat. Please, check the areas on extra information menu.
orders.*.shipping_address.address_1	Address 1	String	Required Max:255	Shipping address line 1.
orders.*.shipping_address.address_2	Address	String	Optional Max:255	Shipping address line 2.
orders.*.shipping_address.postal_code	3215	String	Optional	Postal code.
orders.*.files	[]	Array	Optional	Files like shipping label to be uploaded for the order.
orders..files..title	Shipping Label PDF 1	String	Required	Title of the file.
orders..files..url	{BASE_URL}/images/1.png	String	Required	Url for the file.
orders.*.parcel	\"parcel\": { \"total_weight\": 0.2, \"total_volume\": 0.2, \"box_number\": 1 }	Object	Optional	Parcel
orders.*.parcel.total_weight	0.2	Numeric	optional	Total weight of the parcel
orders.*.parcel.total_volume	0.2	Numeric	optional	Total volume of the parcel
orders.*.parcel.box_number	1	Numeric	optional	Box number
orders.*.delivery_no_generate	1	Boolean	optional	Create shipment
orders.*.order_type	OUTXS	String	optional	Order type
orders.*.carrier	0	Numeric	optional	Shipment carrier
orders.*.delivery_duty_type	DDU	String		Delivery duty type
orders.*.shipping_method	SDD	String	optional	Shipping method

Response description:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
success	Boolean	Status of the request. Possible values: true, false.
code	Numeric	Response code. Possible values: 422, 400.
total_count	String	Response message.
successful_count	Numeric	Created order count
failed_count	Numeric	Failed to create order count
successful	array	Success message list
successful.*.$client_reference	String	Success message
failed	Array	Failed message list
failed.*.$client_reference	String	Failed message

","urlObject":{"path":["api","v3","orders","bulk","create"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"6b6d0c00-4657-43d1-9a2c-9c990173519f"},{"name":"Update","id":"d2b84765-777b-4d3f-aa7a-58b697c2ce8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {token}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client_reference\": \"MAKSATTEST000037\",\n \"order_type\": \"XDOCK\",\n \"total_price\": 393.00,\n \"currency\": \"AED\",\n \"payment_type\": \"COD\",\n \"note\": \"Comments\",\n \"delivery_duty_type\": \"sample\",\n \"shipping_method\": \"sample\",\n \"consignee\": {\n \"name\": \"طوماس طالوت\",\n \"phone\": 565386733,\n \"mobile\": 565386733\n },\n \"skus\": [\n {\n \"code\": \"200G\",\n \"quantity\": 4000,\n \"description\": \"description\",\n \"price\": 10.00,\n \"supplierId\": null,\n \"supplierAddress\": null\n }\n ],\n \"shipping_address\": {\n \"country\": \"UAE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"address_1\": \"عبيد الله عبي دي ياعبيد الله عبيدييا\"\n },\n \"parcel\": {\n \"total_weight\": 1.25,\n \"total_volume\": 3.40,\n \"box_number\": 2\n },\n \"debug\": true\n}","options":{"raw":{"language":"json"}}},"url":"BASE_URL/orders/update","description":"

Updating orders

Body description:

Attribute	Example	Type	Validation	Description
client_reference	IQF00001	String	Required Unique Without Spaces Max: 20	Client reference for order.
note	This is note	String	Optional	Note for order.
payment_type	COD	String	COD or PREPAID	Payment type for order. Possible values: COD, PREPAID. Please, check the payment types on extra information menu.
currency	AED	String	Required	ISO3 code for the currency. Possible values: AED, USD. Please, check the currencies on extra information menu.
total_price	1900	Numeric	Required	Total price of the order.
skus	[ { 'code': 'CODE1', 'quantity':1, 'price':1, 'discounted_price':1 }, ]	Array	Required	Array of SKUs for the order.
skus.*.code	858936006838	String	Required	SKU code. Please, check the skus on extra information menu.
skus.*.quantity	1	Numeric	Required Greater than 0	Quantity of the SKU.
skus.*.price	1	Numeric	Optional	Price of the SKU.
skus.*.discounted_price	1	Numeric	Optional	Discounted price of the SKU.
consignee		Array	Required	Consignee information.
consignee.name	John	String	Required Max:191	Consignee name.
consignee.phone	123456789	Numeric	Required	Consignee phone number.
consignee.mobile	123456789	Numeric	Optional	Consignee mobile number.
consignee.email	example@email.com	String	Required Email format	Consignee email address.
shipping_address		Object	Required	Shipping address information.
shipping_address.country	USA	String	Required Min:2, Max:3	ISO2 or ISO3 name for the shipping country. Possible values: USA, ALB. Please, check the countries on extra information menu.
shipping_address.state	Aseer	String	Required Max:30	Shipping state. Possible values: Al Khobar, Aseer. Please, check the states on extra information menu.
shipping_address.city	Al Khobar	String	Required Max:30	Shipping city. Possible values: Mahayel, Al Khobar. Please, check the cities on extra information menu.
shipping_address.area	Muscat	String	Optional Max:50	Shipping area. Possible values: Muscat. Please, check the areas on extra information menu.
shipping_address.address_1	Address 1	String	Required Max:255	Shipping address line 1.
shipping_address.address_2	Address	String	Optional Max:255	Shipping address line 2.
shipping_address.postal_code	3215	String	Optional	Postal code.
parcel	\"parcel\": { \"total_weight\": 0.2, \"total_volume\": 0.2, \"box_number\": 1 }	Object	Optional	Parcel
parcel.total_weight	0.2	Numeric	optional	Total weight of the parcel
parcel.total_volume	0.2	Numeric	optional	Total volume of the parcel
parcel.box_number	1	Numeric	optional	Box number
order_type	OUTXS	String	optional	Order type
delivery_duty_type	DDU	String		Delivery duty type
shipping_method	SDD	String	optional	Shipping method
debug	true	Boolean	optional	Debug

Response description:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
success	Boolean	Status of the request. Possible values: true, false.
code	Numeric	Response code. Possible values: 422, 400.
message	String	Response message.
client_reference	String	Client Reference

","urlObject":{"path":["orders","update"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"d2b84765-777b-4d3f-aa7a-58b697c2ce8f"},{"name":"Bulk Update","id":"c80486da-10ea-4b70-81b1-fd20e0f2a99a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token_gsc_prod}}","type":"text"},{"key":"Content-Type","value":"application/json; charset=utf-8","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orders\": [\n {\n \"client_reference\": \"MAKSATTEST000034\",\n \"order_type\": \"XDOCK\",\n \"total_price\": 393.00,\n \"currency\": \"AED\",\n \"payment_type\": \"COD\",\n \"note\": \"Comments\",\n \"delivery_duty_type\": \"sample\",\n \"shipping_method\": \"sample\",\n \"consignee\": {\n \"name\": \"طوماس طالوت\",\n \"phone\": 565386733,\n \"mobile\": 565386733\n },\n \"skus\": [\n {\n \"code\": \"200G\",\n \"quantity\": 4000,\n \"description\": \"description\",\n \"price\": 10.00,\n \"supplierId\": null,\n \"supplierAddress\": null\n }\n ],\n \"shipping_address\": {\n \"country\": \"UAE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"address_1\": \"عبيد الله عبي دي ياعبيد الله عبيدييا\"\n },\n \"parcel\": {\n \"total_weight\": 1.25,\n \"total_volume\": 3.40,\n \"box_number\": 2\n },\n \"debug\": true\n },\n {\n \"client_reference\": \"MAKSATTEST000035\",\n \"order_type\": \"XDOCK\",\n \"total_price\": 393.00,\n \"currency\": \"AED\",\n \"payment_type\": \"COD\",\n \"note\": \"Comments\",\n \"delivery_duty_type\": \"sample\",\n \"shipping_method\": \"sample\",\n \"consignee\": {\n \"name\": \"طوماس طالوت\",\n \"phone\": 565386733,\n \"mobile\": 565386733\n },\n \"skus\": [\n {\n \"code\": \"200G\",\n \"quantity\": 4000,\n \"description\": \"description\",\n \"price\": 10.00,\n \"supplierId\": null,\n \"supplierAddress\": null\n }\n ],\n \"shipping_address\": {\n \"country\": \"UAE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"address_1\": \"عبيد الله عبي دي ياعبيد الله عبيدييا\"\n },\n \"parcel\": {\n \"total_weight\": 1.25,\n \"total_volume\": 3.40,\n \"box_number\": 2\n },\n \"debug\": true\n },\n {\n \"client_reference\": \"MAKSATTEST000036\",\n \"order_type\": \"XDOCK\",\n \"total_price\": 393.00,\n \"currency\": \"AED\",\n \"payment_type\": \"COD\",\n \"note\": \"Comments\",\n \"delivery_duty_type\": \"sample\",\n \"shipping_method\": \"sample\",\n \"consignee\": {\n \"name\": \"طوماس طالوت\",\n \"phone\": 565386733,\n \"mobile\": 565386733\n },\n \"skus\": [\n {\n \"code\": \"200G\",\n \"quantity\": 4000,\n \"description\": \"description\",\n \"price\": 10.00,\n \"supplierId\": null,\n \"supplierAddress\": null\n }\n ],\n \"shipping_address\": {\n \"country\": \"UAE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"address_1\": \"عبيد الله عبي دي ياعبيد الله عبيدييا\"\n },\n \"parcel\": {\n \"total_weight\": 1.25,\n \"total_volume\": 3.40,\n \"box_number\": 2\n },\n \"debug\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"BASE_URL/orders/bulk/update","description":"

Updating orders

Body description:

Attribute	Example	Type	Validation	Description
orders.*.client_reference	IQF00001	String	Required Unique Without Spaces Max: 20	Client reference for order.
orders.*.note	This is note	String	Optional	Note for order.
orders.*.payment_type	COD	String	COD or PREPAID	Payment type for order. Possible values: COD, PREPAID. Please, check the payment types on extra information menu.
orders.*.currency	AED	String	Required	ISO3 code for the currency. Possible values: AED, USD. Please, check the currencies on extra information menu.
orders.*.total_price	1900	Numeric	Required	Total price of the order.
orders.*.skus	[ { 'code': 'CODE1', 'quantity':1, 'price':1, 'discounted_price':1 }, ]	Array	Required	Array of SKUs for the order.
orders..skus..code	858936006838	String	Required	SKU code. Please, check the skus on extra information menu.
orders..skus..quantity	1	Numeric	Required Greater than 0	Quantity of the SKU.
orders..skus..price	1	Numeric	Optional	Price of the SKU.
orders..skus..discounted_price	1	Numeric	Optional	Discounted price of the SKU.
orders.*.consignee		Array	Required	Consignee information.
orders.*.consignee.name	John	String	Required Max:191	Consignee name.
orders.*.consignee.phone	123456789	Numeric	Required	Consignee phone number.
orders.*.consignee.mobile	123456789	Numeric	Optional	Consignee mobile number.
orders.*.consignee.email	example@email.com	String	Required Email format	Consignee email address.
orders.*.shipping_address		Object	Required	Shipping address information.
orders.*.shipping_address.country	USA	String	Required Min:2, Max:3	ISO2 or ISO3 name for the shipping country. Possible values: USA, ALB. Please, check the countries on extra information menu.
orders.*.shipping_address.state	Aseer	String	Required Max:30	Shipping state. Possible values: Al Khobar, Aseer. Please, check the states on extra information menu.
shipping_address.city	Al Khobar	String	Required Max:30	Shipping city. Possible values: Mahayel, Al Khobar. Please, check the cities on extra information menu.
shipping_address.area	Muscat	String	Optional Max:50	Shipping area. Possible values: Muscat. Please, check the areas on extra information menu.
shipping_address.address_1	Address 1	String	Required Max:255	Shipping address line 1.
shipping_address.address_2	Address	String	Optional Max:255	Shipping address line 2.
shipping_address.postal_code	3215	String	Optional	Postal code.
parcel	\"parcel\": { \"total_weight\": 0.2, \"total_volume\": 0.2, \"box_number\": 1 }	Object	Optional	Parcel
parcel.total_weight	0.2	Numeric	optional	Total weight of the parcel
parcel.total_volume	0.2	Numeric	optional	Total volume of the parcel
parcel.box_number	1	Numeric	optional	Box number
order_type	OUTXS	String	optional	Order type
delivery_duty_type	DDU	String		Delivery duty type
shipping_method	SDD	String	optional	Shipping method
debug	true	Boolean	optional	Debug

Response description:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
success	Boolean	Status of the request. Possible values: true, false.
code	Numeric	Response code. Possible values: 422, 400.
total_count	String	Response message.
successful_count	Numeric	Created order count
failed_count	Numeric	Failed to create order count
successful	array	Success message list
successful.*.$client_reference	String	Success message
failed	Array	Failed message list
failed.*.$client_reference	String	Failed message

","urlObject":{"path":["orders","bulk","update"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"c80486da-10ea-4b70-81b1-fd20e0f2a99a"},{"name":"Cancel","id":"8d5d9017-00bf-4ea3-b14b-f9514b2eabaf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{token}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client_reference\": \"CLIENTREF1\",\n \"reason\": \"This order is cancelled beacuse of..\"\n}","options":{"raw":{"language":"json"}}},"url":"BASE_URL/api/v3/orders/cancel","description":"

Cancelling order

Body description:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Example	Type	Validation	Description
orders.*.client_reference	IQF00001	String	Required	Client reference for order.
orders.*.reason	This order is cancelled beacuse of	String	Optional	The reason for the order to be cancelled

Response description:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
success	Boolean	Status of the request. Possible values: true, false.
code	Numeric	Response code. Possible values: 422, 400.
message	String	Response message.
client_reference	String	Client reference for the order. Only visible if request is successfull.

","urlObject":{"path":["api","v3","orders","cancel"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"8d5d9017-00bf-4ea3-b14b-f9514b2eabaf"},{"name":"Bulk Cancel","id":"1494e1b8-a255-48af-bbc6-26f1dd2eee27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{token}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orders\": [\n {\n \"client_reference\": \"CLIENTREF1\",\n \"reason\": \"This order is cancelled beacuse of..\"\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"BASE_URL/api/v3/orders/cancel","description":"

Bulk Cancelling order

Body description:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Example	Type	Validation	Description
client_reference	IQF00001	String	Required	Client reference for order.
reason	This order is cancelled beacuse of	String	Optional	The reason for the order to be cancelled

Response description:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
success	Boolean	Status of the request. Possible values: true, false.
code	Numeric	Response code. Possible values: 422, 400.
total_count	String	Response message.
successful_count	Numeric	Created order count
failed_count	Numeric	Failed to create order count
successful	array	Success message list
successful.*.$client_reference	String	Success message
failed	Array	Failed message list
failed.*.$client_reference	String	Failed message

","urlObject":{"path":["api","v3","orders","cancel"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"1494e1b8-a255-48af-bbc6-26f1dd2eee27"}],"id":"7bfdea4e-c378-498d-91bd-2449f066bdfe","_postman_id":"7bfdea4e-c378-498d-91bd-2449f066bdfe","description":""},{"name":"SKU","item":[{"name":"Get","id":"a6db6a6a-65a6-4d59-84eb-3dfbace87dd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"per_page\": 10,\n \"page\": 1,\n \"sku_type\": \"Regular\"\n}"},"url":"BASE_URL/api/v3/skus","description":"

Body description:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Example	Type	Validation	Description
page	1	Integer	Optional	Page number of pagination. Default value: 1
per_page	50	Integer	Optional	Items number on per page. Default value: 50
skus	[\"123\", \"123\"]	array	Optional	SKU's system code to filter data.

Response description:

Attribute	Type	Description
success	boolean	Status of request.
pagination	object	Pagination data.
pagination.per_page	integer	The number of items to be shown per page. Default 50
pagination.current_page	integer	The current page number. Default 1
pagination.last_page	integer	The last page number.
pagination.total	integer	The total number of rows.
applied_filters	array	The array of applied filters.
applied_filters.sku_type	string	SKU type which is applied in the filter.
applied_filters.sku_number	string	SKU system code which is applied in the filter.
applied_filters.category	string	Category which is applied in the filter.
applied_filters.sub_category	string	Sub-category which is applied in the filter.
applied_filters.status	string	Status which is applied in the filter.
data	array	List of data.
data.*.id	integer	Unique ID number of SKU
data.*.status	string	Current status of SKU
data.*.sku_number	string	Unique system code of SKU
data.*.alter_sku_name	string	Alternative sku system code of SKU
data.*.description	string	SKU short description
data.*.brand	string	Brand name of the SKU
data.*.category	string	Category name of the SKU
data.*.sub_category	string	Sub-category name of the SKU
data.*.photo	string	Image url of the SKU
data.*.weight	float	Weight of the SKU
data.*.cubee	float	Cube of the SKU
data.*.length	float	Length of the SKU
data.*.width	float	Width of the SKU
data.*.height	float	Height of the SKU
data.*.size	string	Size of the SKU
data.*.color	string	Color of the SKU
data.*.design_number	string	Design number of the SKU
data.*.sku_type	string	SKU type
data.*.order_count	integer	Number of orders
data.*.system_creation_time	string	SKU creation timestamp
data.*.insert_time	string	SKU insertion timestamp
data.*.product	string	The product name of related sku
data.*.currency	string	SKU currency code
data.*.cost_price	float	Cost price of the SKU
data.*.price	float	Price of the SKU
data.*.discounted_price	float	Discounted price of the SKU
data.*.is_default	boolean	Default SKU indicator
data.*.last_order_dropped	string	Last order dropped timestamp
data.*.status	string	Status of the SKU
data.*.hs_code	string	HS code of the SKU
data.*.country	string	The country code of the SKU
data.*.expiry_control	boolean	Expiry control flag
data.*.serial_number_control	boolean	Serial number control flag

","urlObject":{"path":["api","v3","skus"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[{"id":"2900e133-721a-482b-b4a1-b3335e76d1de","name":"Get SKUs","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"per_page\": 10,\n \"page\": 1,\n \"sku_type\": \"Regular\"\n}"},"url":"BASE_URL/api/v3/skus"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 19 Jul 2023 07:10:49 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/8.1.10"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Vary","value":"Authorization,Origin"},{"key":"X-Powered-By","value":"PHP/8.1.10"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"120"},{"key":"X-RateLimit-Remaining","value":"119"},{"key":"X-Clockwork-Id","value":"1689750649-8713-1268109900"},{"key":"X-Clockwork-Version","value":"5.1.11"},{"key":"Server-Timing","value":"app; dur=222.07283973694; desc=\"Application\", db; dur=151.75; desc=\"Database\", timeline-event-0; dur=194.43416595459; desc=\"Controller\""},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"pagination\": {\n \"per_page\": 10,\n \"current_page\": 1,\n \"last_page\": 18967,\n \"total\": 189661\n },\n \"applied_filters\": {\n \"sku_type\": \"Regular\"\n },\n \"data\": [\n {\n \"id\": 198643,\n \"status\": \"Enabled\",\n \"sku_number\": \"TESTPERFSKU2524\",\n \"alter_sku_name\": null,\n \"description\": \"TESTPERFSKU2524\",\n \"brand\": null,\n \"category\": null,\n \"sub_category\": null,\n \"photo\": null,\n \"weight\": 0,\n \"cubee\": 0,\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"size\": 0,\n \"color\": null,\n \"design_number\": null,\n \"sku_type\": \"Regular\",\n \"order_count\": 167,\n \"system_creation_time\": \"2023-07-07 08:03:58\",\n \"insert_time\": \"2023-07-07 08:03:58\",\n \"product\": null,\n \"currency\": null,\n \"cost_price\": 0,\n \"price\": 0,\n \"discounted_price\": 0,\n \"is_default\": false,\n \"last_order_dropped\": \"2023-07-12T02:10:55.000000Z\",\n \"hs_code\": null,\n \"country\": null,\n \"expiry_control\": 0,\n \"serial_number_control\": 0\n },\n {\n \"id\": 198642,\n \"status\": \"Enabled\",\n \"sku_number\": \"TESTPERFSKU2523\",\n \"alter_sku_name\": null,\n \"description\": \"TESTPERFSKU2523\",\n \"brand\": null,\n \"category\": null,\n \"sub_category\": null,\n \"photo\": null,\n \"weight\": 0,\n \"cubee\": 0,\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"size\": 0,\n \"color\": null,\n \"design_number\": null,\n \"sku_type\": \"Regular\",\n \"order_count\": 165,\n \"system_creation_time\": \"2023-07-07 08:03:58\",\n \"insert_time\": \"2023-07-07 08:03:58\",\n \"product\": null,\n \"currency\": null,\n \"cost_price\": 0,\n \"price\": 0,\n \"discounted_price\": 0,\n \"is_default\": false,\n \"last_order_dropped\": \"2023-07-12T02:10:55.000000Z\",\n \"hs_code\": null,\n \"country\": null,\n \"expiry_control\": 0,\n \"serial_number_control\": 0\n },\n {\n \"id\": 198641,\n \"status\": \"Enabled\",\n \"sku_number\": \"TESTPERFSKU2522\",\n \"alter_sku_name\": null,\n \"description\": \"TESTPERFSKU2522\",\n \"brand\": null,\n \"category\": null,\n \"sub_category\": null,\n \"photo\": null,\n \"weight\": 0,\n \"cubee\": 0,\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"size\": 0,\n \"color\": null,\n \"design_number\": null,\n \"sku_type\": \"Regular\",\n \"order_count\": 165,\n \"system_creation_time\": \"2023-07-07 08:03:58\",\n \"insert_time\": \"2023-07-07 08:03:58\",\n \"product\": null,\n \"currency\": null,\n \"cost_price\": 0,\n \"price\": 0,\n \"discounted_price\": 0,\n \"is_default\": false,\n \"last_order_dropped\": \"2023-07-12T02:10:55.000000Z\",\n \"hs_code\": null,\n \"country\": null,\n \"expiry_control\": 0,\n \"serial_number_control\": 0\n },\n {\n \"id\": 198640,\n \"status\": \"Enabled\",\n \"sku_number\": \"TESTPERFSKU2521\",\n \"alter_sku_name\": null,\n \"description\": \"TESTPERFSKU2521\",\n \"brand\": null,\n \"category\": null,\n \"sub_category\": null,\n \"photo\": null,\n \"weight\": 0,\n \"cubee\": 0,\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"size\": 0,\n \"color\": null,\n \"design_number\": null,\n \"sku_type\": \"Regular\",\n \"order_count\": 165,\n \"system_creation_time\": \"2023-07-07 08:03:58\",\n \"insert_time\": \"2023-07-07 08:03:58\",\n \"product\": null,\n \"currency\": null,\n \"cost_price\": 0,\n \"price\": 0,\n \"discounted_price\": 0,\n \"is_default\": false,\n \"last_order_dropped\": \"2023-07-12T02:10:55.000000Z\",\n \"hs_code\": null,\n \"country\": null,\n \"expiry_control\": 0,\n \"serial_number_control\": 0\n },\n {\n \"id\": 198639,\n \"status\": \"Enabled\",\n \"sku_number\": \"TESTPERFSKU2520\",\n \"alter_sku_name\": null,\n \"description\": \"TESTPERFSKU2520\",\n \"brand\": null,\n \"category\": null,\n \"sub_category\": null,\n \"photo\": null,\n \"weight\": 0,\n \"cubee\": 0,\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"size\": 0,\n \"color\": null,\n \"design_number\": null,\n \"sku_type\": \"Regular\",\n \"order_count\": 165,\n \"system_creation_time\": \"2023-07-07 08:03:58\",\n \"insert_time\": \"2023-07-07 08:03:58\",\n \"product\": null,\n \"currency\": null,\n \"cost_price\": 0,\n \"price\": 0,\n \"discounted_price\": 0,\n \"is_default\": false,\n \"last_order_dropped\": \"2023-07-12T02:10:55.000000Z\",\n \"hs_code\": null,\n \"country\": null,\n \"expiry_control\": 0,\n \"serial_number_control\": 0\n },\n {\n \"id\": 198638,\n \"status\": \"Enabled\",\n \"sku_number\": \"TESTPERFSKU2519\",\n \"alter_sku_name\": null,\n \"description\": \"TESTPERFSKU2519\",\n \"brand\": null,\n \"category\": null,\n \"sub_category\": null,\n \"photo\": null,\n \"weight\": 0,\n \"cubee\": 0,\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"size\": 0,\n \"color\": null,\n \"design_number\": null,\n \"sku_type\": \"Regular\",\n \"order_count\": 165,\n \"system_creation_time\": \"2023-07-07 08:03:58\",\n \"insert_time\": \"2023-07-07 08:03:58\",\n \"product\": null,\n \"currency\": null,\n \"cost_price\": 0,\n \"price\": 0,\n \"discounted_price\": 0,\n \"is_default\": false,\n \"last_order_dropped\": \"2023-07-12T02:10:55.000000Z\",\n \"hs_code\": null,\n \"country\": null,\n \"expiry_control\": 0,\n \"serial_number_control\": 0\n },\n {\n \"id\": 198637,\n \"status\": \"Enabled\",\n \"sku_number\": \"TESTPERFSKU2518\",\n \"alter_sku_name\": null,\n \"description\": \"TESTPERFSKU2518\",\n \"brand\": null,\n \"category\": null,\n \"sub_category\": null,\n \"photo\": null,\n \"weight\": 0,\n \"cubee\": 0,\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"size\": 0,\n \"color\": null,\n \"design_number\": null,\n \"sku_type\": \"Regular\",\n \"order_count\": 165,\n \"system_creation_time\": \"2023-07-07 08:03:58\",\n \"insert_time\": \"2023-07-07 08:03:58\",\n \"product\": null,\n \"currency\": null,\n \"cost_price\": 0,\n \"price\": 0,\n \"discounted_price\": 0,\n \"is_default\": false,\n \"last_order_dropped\": \"2023-07-12T02:10:55.000000Z\",\n \"hs_code\": null,\n \"country\": null,\n \"expiry_control\": 0,\n \"serial_number_control\": 0\n },\n {\n \"id\": 198636,\n \"status\": \"Enabled\",\n \"sku_number\": \"TESTPERFSKU2517\",\n \"alter_sku_name\": null,\n \"description\": \"TESTPERFSKU2517\",\n \"brand\": null,\n \"category\": null,\n \"sub_category\": null,\n \"photo\": null,\n \"weight\": 0,\n \"cubee\": 0,\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"size\": 0,\n \"color\": null,\n \"design_number\": null,\n \"sku_type\": \"Regular\",\n \"order_count\": 165,\n \"system_creation_time\": \"2023-07-07 08:03:58\",\n \"insert_time\": \"2023-07-07 08:03:58\",\n \"product\": null,\n \"currency\": null,\n \"cost_price\": 0,\n \"price\": 0,\n \"discounted_price\": 0,\n \"is_default\": false,\n \"last_order_dropped\": \"2023-07-12T02:10:55.000000Z\",\n \"hs_code\": null,\n \"country\": null,\n \"expiry_control\": 0,\n \"serial_number_control\": 0\n },\n {\n \"id\": 198635,\n \"status\": \"Enabled\",\n \"sku_number\": \"TESTPERFSKU2516\",\n \"alter_sku_name\": null,\n \"description\": \"TESTPERFSKU2516\",\n \"brand\": null,\n \"category\": null,\n \"sub_category\": null,\n \"photo\": null,\n \"weight\": 0,\n \"cubee\": 0,\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"size\": 0,\n \"color\": null,\n \"design_number\": null,\n \"sku_type\": \"Regular\",\n \"order_count\": 165,\n \"system_creation_time\": \"2023-07-07 08:03:58\",\n \"insert_time\": \"2023-07-07 08:03:58\",\n \"product\": null,\n \"currency\": null,\n \"cost_price\": 0,\n \"price\": 0,\n \"discounted_price\": 0,\n \"is_default\": false,\n \"last_order_dropped\": \"2023-07-12T02:10:55.000000Z\",\n \"hs_code\": null,\n \"country\": null,\n \"expiry_control\": 0,\n \"serial_number_control\": 0\n },\n {\n \"id\": 198634,\n \"status\": \"Enabled\",\n \"sku_number\": \"TESTPERFSKU2515\",\n \"alter_sku_name\": null,\n \"description\": \"TESTPERFSKU2515\",\n \"brand\": null,\n \"category\": null,\n \"sub_category\": null,\n \"photo\": null,\n \"weight\": 0,\n \"cubee\": 0,\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"size\": 0,\n \"color\": null,\n \"design_number\": null,\n \"sku_type\": \"Regular\",\n \"order_count\": 165,\n \"system_creation_time\": \"2023-07-07 08:03:58\",\n \"insert_time\": \"2023-07-07 08:03:58\",\n \"product\": null,\n \"currency\": null,\n \"cost_price\": 0,\n \"price\": 0,\n \"discounted_price\": 0,\n \"is_default\": false,\n \"last_order_dropped\": \"2023-07-12T02:10:55.000000Z\",\n \"hs_code\": null,\n \"country\": null,\n \"expiry_control\": 0,\n \"serial_number_control\": 0\n }\n ]\n}"}],"_postman_id":"a6db6a6a-65a6-4d59-84eb-3dfbace87dd2"},{"name":"Create","id":"5b5a8fb7-34ab-441a-a75c-bafab91c1cb9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"TOKEN","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"sku","value":" SKU005","type":"text"},{"key":"sku_type","value":" Regular","type":"text"},{"key":"alternative_sku_name","value":" SKUALTER005","type":"text"},{"key":"photo","type":"file","src":"/home/elliot/Downloads/test_image.png"},{"key":"description","value":" My first product.","type":"text"},{"key":"weight","value":" 1.11","type":"text"},{"key":"cube","value":" 1.11","type":"text"},{"key":"length","value":" 1.11","type":"text"},{"key":"width","value":" 1.11","type":"text"},{"key":"height","value":" 1.11","type":"text"},{"key":"brand","value":" IQ Fulfillment","type":"text"},{"key":"color","value":" Black","type":"text"},{"key":"hscode","value":" 90.04.10.91.10","type":"text"},{"key":"origin_country","value":" UAE","type":"text"},{"key":"serial_number_required","value":" true","type":"text"},{"key":"value_added_services","value":" true","type":"text"},{"key":"need_expiry_date","value":" true","type":"text"}]},"url":"BASE_URL/api/v3/skus/create","description":"

Description: sku creation

Attribute	Example	Type	Validation	Description
sku	TEST001	string	required freetext need to be unique	Unique system code of SKU
sku_type	Regular	string	required exists in sku type	SKU type.
alter_sku_name	ALTTEST001	string	optional freetext	Alternative sku system code of SKU
photo	image.jpeg	Image	Optional	Image for SKU.
description	A short test description.	string	optional freetext	A short description of SKU
weight	1.5	float	optional numeric	Weight of the SKU
cubee	1.5	float	optional numeric	Cube of the SKU
length	1	float	optional numeric	Length of the SKU
width	1	float	optional numeric	Width of the SKU
height	1	float	optional numeric	Height of the SKU
brand	Brand001	string	optional freetext	Brand name of the SKU
color	Red	string	optional	Color of the SKU
hs_code	HSTEST001	string	optional freetext	HS code of the SKU
origin_country	UAE	string	optional country code	The country code of the SKU
serial_number_required	true	Boolean	optional	Is serial number required
value_added_services	true	Boolean	optional	Valude added services
need_expiry_date	true	Boolean	optional	Need expire date

Response description:

Attribute	Type	Description
success	boolean	Status of request.
data	object	List of data.
data.id	integer	Unique ID number of Sku
data.status	string	Current status of Sku
data.sku_number	string	Unique system code of Sku
data.alter_sku_name	string	Alternative sku system code of Sku
data.description	string	SKU short description
data.brand	string	Brand name of the sku
data.category	string	Category name of the sku
data.sub_category	string	Sub-category name of the sku
data.photo	string	Image url of the sku
data.weight	float	Weight of the sku
data.cubee	float	Cube of the sku
data.length	float	Length of the sku
data.width	float	Width of the sku
data.height	float	Height of the Sku
data.size	string	Size of the Sku
data.color	string	Color of the Sku
data.design_number	string	Design number of the Sku
data.sku_type	string	Sku type
data.order_count	integer	Number of orders
data.system_creation_time	string	Sku creation timestamp
data.insert_time	string	Sku insertion timestamp
data.product	string	The product name of related sku
data.currency	string	Sku currency code
data.cost_price	float	Cost price of the Sku
data.price	float	Price of the Sku
data.discounted_price	float	Discounted price of the Sku
data.is_default	boolean	Default Sku indicator
data.last_order_dropped	string	Last order dropped timestamp
data.status	string	Status of the Sku
data.hs_code	string	HS code of the Sku
data.country	string	The country code of the sku
data.expiry_control	boolean	Expiry control flag
data.serial_number_control	boolean	Serial number control flag
alternative_sku_codes	array	List of alternate sku codes

","urlObject":{"path":["api","v3","skus","create"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[{"id":"bcb808a3-c174-4aff-8912-ee0058cc9412","name":"Create SKU","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"TOKEN","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"sku","value":" SKU005","type":"text"},{"key":"sku_type","value":" Regular","type":"text"},{"key":"alternative_sku_name","value":" SKUALTER005","type":"text"},{"key":"description","value":" My first product.","type":"text"},{"key":"weight","value":" 1.11","type":"text"},{"key":"cube","value":" 1.11","type":"text"},{"key":"length","value":" 1.11","type":"text"},{"key":"width","value":" 1.11","type":"text"},{"key":"height","value":" 1.11","type":"text"},{"key":"brand","value":" IQ Fulfillment","type":"text"},{"key":"color","value":" Black","type":"text"},{"key":"hscode","value":" 90.04.10.91.10","type":"text"},{"key":"origin_country","value":" UAE","type":"text"},{"key":"serial_number_required","value":" true","type":"text"},{"key":"value_added_services","value":" true","type":"text"},{"key":"need_expiry_date","value":" true","type":"text"}]},"url":"BASE_URL/api/v3/skus/create"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 19 Jul 2023 07:22:33 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/8.1.10"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Vary","value":"Authorization,Origin"},{"key":"X-Powered-By","value":"PHP/8.1.10"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"120"},{"key":"X-RateLimit-Remaining","value":"118"},{"key":"X-Clockwork-Id","value":"1689751353-8428-1785393201"},{"key":"X-Clockwork-Version","value":"5.1.11"},{"key":"Server-Timing","value":"app; dur=112.32781410217; desc=\"Application\", db; dur=16.76; desc=\"Database\", timeline-event-0; dur=72.641849517822; desc=\"Controller\""},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 198644,\n \"sku\": \"TESTSKU001\",\n \"alternative_sku_name\": null,\n \"sku_type\":\"Regular\",\n \"description\": \"A short test description.\",\n \"brand\": \"IQF\",\n \"weight\": 0,\n \"cubee\": 0,\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"size\": 0,\n \"color\": null,\n \"hs_code\": null,\n \"origin_country\": \"UAE\",\n \"serial_number_required\":1,\n \"value_added_services\":1,\n \"need_expiry_date\":1,\n \"created_at\": \"12121\"\n }\n}"}],"_postman_id":"5b5a8fb7-34ab-441a-a75c-bafab91c1cb9"},{"name":"Create Bulk","id":"87267d48-d92a-44bb-83ed-60b15f53c85d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"skus\": [\n {\n \"sku\": \"SKU005\",\n \"alternative_sku_name\": \"SKUALTER005\",\n \"sku_type\": \"Regular\",\n \"description\": \"My first product.\",\n \"weight\": 1.11,\n \"cube\": 1.11,\n \"length\": 1.11,\n \"width\": 1.11,\n \"height\": 1.11,\n \"brand\": \"IQ Fulfillment\",\n \"color\": \"Black\",\n \"hscode\": \"90.04.10.91.10\",\n \"origin_country\": \"UAE\",\n \"serial_number_required\": true,\n \"value_added_services\": true,\n \"need_expiry_date\": true\n }\n ]\n}"},"url":"BASE_URL/api/v3/skus/bulk/create","description":"

Description: bulk sku creation

Attribute	Example	Type	Validation	Description
skus.*.sku_type	Regular	string	required exists in sku type	SKU type.
skus.*.sku	TEST001	string	required freetext need to be unique	Unique system code of SKU
skus.*.alter_sku_name	ALTTEST001	string	optional freetext	Alternative sku system code of SKU
skus.*.description	A short test description.	string	optional freetext	A short description of SKU
skus.*.brand	Brand001	string	optional freetext	Brand name of the SKU
skus.*.weight	1.5	float	optional numeric	Weight of the SKU
skus.*.cubee	1.5	float	optional numeric	Cube of the SKU
skus.*.length	1	float	optional numeric	Length of the SKU
skus.*.width	1	float	optional numeric	Width of the SKU
skus.*.height	1	float	optional numeric	Height of the SKU
skus.*.color	Red	string	optional	Color of the SKU
skus.*.hs_code	HSTEST001	string	optional freetext	HS code of the SKU
skus.*.origin_country	UAE	string	optional country code	The country code of the SKU
skus.*.serial_number_required	true	Boolean	optional	Is serial number required
skus.*.value_added_services	true	Boolean	optional	Valude added services
skus.*.need_expiry_date	true	Boolean	optional	Need expire date

Response description:

Attribute	Type	Description
success	boolean	Status of request.
data	object	List of data.
data.id	integer	Unique ID number of Sku
data.status	string	Current status of Sku
data.sku_number	string	Unique system code of Sku
data.alter_sku_name	string	Alternative sku system code of Sku
data.description	string	SKU short description
data.brand	string	Brand name of the sku
data.category	string	Category name of the sku
data.sub_category	string	Sub-category name of the sku
data.photo	string	Image url of the sku
data.weight	float	Weight of the sku
data.cubee	float	Cube of the sku
data.length	float	Length of the sku
data.width	float	Width of the sku
data.height	float	Height of the Sku
data.size	string	Size of the Sku
data.color	string	Color of the Sku
data.design_number	string	Design number of the Sku
data.sku_type	string	Sku type
data.order_count	integer	Number of orders
data.system_creation_time	string	Sku creation timestamp
data.insert_time	string	Sku insertion timestamp
data.product	string	The product name of related sku
data.currency	string	Sku currency code
data.cost_price	float	Cost price of the Sku
data.price	float	Price of the Sku
data.discounted_price	float	Discounted price of the Sku
data.is_default	boolean	Default Sku indicator
data.last_order_dropped	string	Last order dropped timestamp
data.status	string	Status of the Sku
data.hs_code	string	HS code of the Sku
data.country	string	The country code of the sku
data.expiry_control	boolean	Expiry control flag
data.serial_number_control	boolean	Serial number control flag
alternative_sku_codes	array	List of alternate sku codes

","urlObject":{"path":["api","v3","skus","bulk","create"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[{"id":"87074738-5ac4-43ca-9401-fc885ed44696","name":"Create SKU","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"skus\": [\n {\n \"sku_type\": \"Regular\",\n \"sku_number\": \"TESTSKU00334\",\n \"alter_sku_name\": \"ALTTESTSKU001\",\n \"description\": \"A short test description.\",\n \"brand\": \"IQF\",\n \"category\": \"PANTS\",\n \"sub_category\": \"PANTS\",\n \"weight\": 0,\n \"cubee\": 0,\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"size\": null,\n \"color\": null,\n \"design_number\": null,\n \"currency\": \"AED\",\n \"cost_price\": 0,\n \"price\": 100,\n \"discounted_price\": null,\n \"hs_code\": null,\n \"country\": \"UAE\",\n \"alternative_sku_codes\": [\n \"ALTR001\",\n \"ALTR02\"\n ]\n },\n {\n //\"sku_type\": \"Regular\",\n \"sku_number\": \"TESTSKU00335\",\n \"alter_sku_name\": \"ALTTESTSKU001\",\n \"description\": \"A short test description.\",\n \"brand\": \"IQF\",\n \"category\": \"PANTS\",\n \"sub_category\": \"PANTS\",\n \"weight\": 0,\n \"cubee\": 0,\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"size\": null,\n \"color\": null,\n \"design_number\": null,\n \"currency\": \"AED\",\n \"cost_price\": 0,\n \"price\": 100,\n \"discounted_price\": null,\n \"hs_code\": null,\n \"country\": \"UAE\",\n \"alternative_sku_codes\": [\n \"ALTR001\",\n \"ALTR02\"\n ]\n }\n ]\n}"},"url":"BASE_URL/api/v3/skus/bulk/create"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.25.1"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.2.7"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 19 Oct 2023 09:01:51 GMT"},{"key":"X-RateLimit-Limit","value":"120"},{"key":"X-RateLimit-Remaining","value":"119"},{"key":"Vary","value":"Origin"},{"key":"X-Clockwork-Id","value":"1697706111-0463-2089001364"},{"key":"X-Clockwork-Version","value":"5.1.11"},{"key":"Server-Timing","value":"app; dur=122.94220924377; desc=\"Application\", db; dur=28.36; desc=\"Database\", timeline-event-0; dur=65.355777740479; desc=\"Controller\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"total_count\": 2,\n \"successful_count\": 1,\n \"failed_count\": 1,\n \"failed\": {\n \"TESTSKU00335\": {\n \"sku_type\": [\n \"The sku type field is required.\"\n ]\n }\n },\n \"successful\": {\n \"TESTSKU00334\": {\n \"id\": 195052,\n \"status\": \"Enabled\",\n \"sku_number\": \"TESTSKU00334\",\n \"alter_sku_name\": \"ALTTESTSKU001\",\n \"description\": \"A short test description.\",\n \"brand\": \"IQF\",\n \"category\": null,\n \"sub_category\": null,\n \"photo\": null,\n \"weight\": 0,\n \"cubee\": 0,\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"size\": 0,\n \"color\": \"0\",\n \"design_number\": null,\n \"sku_type\": \"Regular\",\n \"order_count\": 0,\n \"system_creation_time\": \"2023-10-19 13:01:51\",\n \"insert_time\": \"2023-10-19 13:01:51\",\n \"product\": null,\n \"currency\": \"AED\",\n \"cost_price\": 0,\n \"price\": 100,\n \"discounted_price\": 0,\n \"is_default\": false,\n \"last_order_dropped\": null,\n \"hs_code\": null,\n \"country\": \"United Arab Emirates\",\n \"expiry_control\": 0,\n \"serial_number_control\": 0\n }\n }\n}"}],"_postman_id":"87267d48-d92a-44bb-83ed-60b15f53c85d"},{"name":"Update","id":"8c031f7f-8895-4bdc-903c-ea0960060a1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"sku\": \"SKU005\",\n \"alternative_sku_name\": \"SKUALTER005\",\n \"sku_type\": \"Regular\",\n \"description\": \"My first product.\",\n \"weight\": 1.11,\n \"cube\": 1.11,\n \"length\": 1.11,\n \"width\": 1.11,\n \"height\": 1.11,\n \"brand\": \"IQ Fulfillment\",\n \"color\": \"Black\",\n \"hscode\": \"90.04.10.91.10\",\n \"origin_country\": \"UAE\",\n \"serial_number_required\": true,\n \"value_added_services\": true,\n \"need_expiry_date\": true\n}"},"url":"BASE_URL/api/v3/skus/update","description":"

Description: sku update

Attribute	Example	Type	Validation	Description
sku_type	Regular	string	required exists in sku type	SKU type.
sku	TEST001	string	required freetext need to be unique	Unique system code of SKU
alter_sku_name	ALTTEST001	string	optional freetext	Alternative sku system code of SKU
description	A short test description.	string	optional freetext	A short description of SKU
brand	Brand001	string	optional freetext	Brand name of the SKU
weight	1.5	float	optional numeric	Weight of the SKU
cubee	1.5	float	optional numeric	Cube of the SKU
length	1	float	optional numeric	Length of the SKU
width	1	float	optional numeric	Width of the SKU
height	1	float	optional numeric	Height of the SKU
color	Red	string	optional	Color of the SKU
hs_code	HSTEST001	string	optional freetext	HS code of the SKU
origin_country	UAE	string	optional country code	The country code of the SKU
serial_number_required	true	Boolean	optional	Is serial number required
value_added_services	true	Boolean	optional	Valude added services
need_expiry_date	true	Boolean	optional	Need expire date

Response description:

Attribute	Type	Description
success	boolean	Status of request.
data	object	List of data.
data.id	integer	Unique ID number of Sku
data.status	string	Current status of Sku
data.sku_number	string	Unique system code of Sku
data.alter_sku_name	string	Alternative sku system code of Sku
data.description	string	SKU short description
data.brand	string	Brand name of the sku
data.category	string	Category name of the sku
data.sub_category	string	Sub-category name of the sku
data.photo	string	Image url of the sku
data.weight	float	Weight of the sku
data.cubee	float	Cube of the sku
data.length	float	Length of the sku
data.width	float	Width of the sku
data.height	float	Height of the Sku
data.size	string	Size of the Sku
data.color	string	Color of the Sku
data.design_number	string	Design number of the Sku
data.sku_type	string	Sku type
data.order_count	integer	Number of orders
data.system_creation_time	string	Sku creation timestamp
data.insert_time	string	Sku insertion timestamp
data.product	string	The product name of related sku
data.currency	string	Sku currency code
data.cost_price	float	Cost price of the Sku
data.price	float	Price of the Sku
data.discounted_price	float	Discounted price of the Sku
data.is_default	boolean	Default Sku indicator
data.last_order_dropped	string	Last order dropped timestamp
data.status	string	Status of the Sku
data.hs_code	string	HS code of the Sku
data.country	string	The country code of the sku
data.expiry_control	boolean	Expiry control flag
data.serial_number_control	boolean	Serial number control flag
alternative_sku_codes	array	List of alternate sku codes

","urlObject":{"path":["api","v3","skus","update"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[{"id":"3f511112-1a0c-4a83-8bc0-6c015b44d5db","name":"Update SKU","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": 198644,\n \"sku_type\": \"Regular\",\n \"sku_number\": \"TESTSKU001\",\n \"alterSkuName\": \"ALTTESTSKU001\",\n \"description\": \"A short test description.\",\n \"brand\": \"IQF\",\n \"category\": \"PANTS\",\n \"sub_category\": \"STOCKING\",\n \"weight\": 0,\n \"cubee\": 0,\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"size\": null,\n \"color\": \"Red\",\n \"design_number\": null,\n \"currency\": \"AED\",\n \"cost_price\": 0,\n \"price\": 100,\n \"discounted_price\": null,\n \"hs_code\": null,\n \"country\": \"UAE\"\n}"},"url":"BASE_URL/api/v3/skus/update"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 19 Jul 2023 07:24:13 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/8.1.10"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Vary","value":"Authorization,Origin"},{"key":"X-Powered-By","value":"PHP/8.1.10"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"120"},{"key":"X-RateLimit-Remaining","value":"118"},{"key":"X-Clockwork-Id","value":"1689751453-3777-925980657"},{"key":"X-Clockwork-Version","value":"5.1.11"},{"key":"Server-Timing","value":"app; dur=74.470043182373; desc=\"Application\", db; dur=9.81; desc=\"Database\", timeline-event-0; dur=49.819946289062; desc=\"Controller\""},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 198644,\n \"status\": \"Enabled\",\n \"sku_number\": \"TESTSKU001\",\n \"alter_sku_name\": null,\n \"description\": \"A short test description.\",\n \"brand\": \"IQF\",\n \"category\": \"PANTS\",\n \"sub_category\": \"STOCKING\",\n \"photo\": null,\n \"weight\": 0,\n \"cubee\": 0,\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"size\": 0,\n \"color\": \"Red\",\n \"design_number\": null,\n \"sku_type\": \"Regular\",\n \"order_count\": 0,\n \"system_creation_time\": \"2023-07-19 11:22:33\",\n \"insert_time\": \"2023-07-19 11:22:33\",\n \"product\": null,\n \"currency\": \"AED\",\n \"cost_price\": 0,\n \"price\": 100,\n \"discounted_price\": 0,\n \"is_default\": false,\n \"last_order_dropped\": null,\n \"hs_code\": null,\n \"country\": \"United Arab Emirates\",\n \"expiry_control\": 0,\n \"serial_number_control\": 0\n }\n}"}],"_postman_id":"8c031f7f-8895-4bdc-903c-ea0960060a1a"},{"name":"Update SKU Bulk","id":"891f1452-e29e-4916-970f-21bb8fc876a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"skus\": [\n {\n \"sku\": \"SKU005\",\n \"alternative_sku_name\": \"SKUALTER005\",\n \"sku_type\": \"Regular\",\n \"description\": \"My first product.\",\n \"weight\": 1.11,\n \"cube\": 1.11,\n \"length\": 1.11,\n \"width\": 1.11,\n \"height\": 1.11,\n \"brand\": \"IQ Fulfillment\",\n \"color\": \"Black\",\n \"hscode\": \"90.04.10.91.10\",\n \"origin_country\": \"UAE\",\n \"serial_number_required\": true,\n \"value_added_services\": true,\n \"need_expiry_date\": true\n }\n ]\n}"},"url":"BASE_URL/api/v3/skus/bulk/update","description":"

Description: bulk sku creation

Attribute	Example	Type	Validation	Description
skus.*.sku_type	Regular	string	required exists in sku type	SKU type.
skus.*.sku	TEST001	string	required freetext need to be unique	Unique system code of SKU
skus.*.alter_sku_name	ALTTEST001	string	optional freetext	Alternative sku system code of SKU
skus.*.description	A short test description.	string	optional freetext	A short description of SKU
skus.*.brand	Brand001	string	optional freetext	Brand name of the SKU
skus.*.weight	1.5	float	optional numeric	Weight of the SKU
skus.*.cubee	1.5	float	optional numeric	Cube of the SKU
skus.*.length	1	float	optional numeric	Length of the SKU
skus.*.width	1	float	optional numeric	Width of the SKU
skus.*.height	1	float	optional numeric	Height of the SKU
skus.*.color	Red	string	optional	Color of the SKU
skus.*.hs_code	HSTEST001	string	optional freetext	HS code of the SKU
skus.*.origin_country	UAE	string	optional country code	The country code of the SKU
skus.*.serial_number_required	true	Boolean	optional	Is serial number required
skus.*.value_added_services	true	Boolean	optional	Valude added services
skus.*.need_expiry_date	true	Boolean	optional	Need expire date

Response description:

Attribute	Type	Description
success	boolean	Status of request.
data	object	List of data.
data.id	integer	Unique ID number of Sku
data.status	string	Current status of Sku
data.sku_number	string	Unique system code of Sku
data.alter_sku_name	string	Alternative sku system code of Sku
data.description	string	SKU short description
data.brand	string	Brand name of the sku
data.category	string	Category name of the sku
data.sub_category	string	Sub-category name of the sku
data.photo	string	Image url of the sku
data.weight	float	Weight of the sku
data.cubee	float	Cube of the sku
data.length	float	Length of the sku
data.width	float	Width of the sku
data.height	float	Height of the Sku
data.size	string	Size of the Sku
data.color	string	Color of the Sku
data.design_number	string	Design number of the Sku
data.sku_type	string	Sku type
data.order_count	integer	Number of orders
data.system_creation_time	string	Sku creation timestamp
data.insert_time	string	Sku insertion timestamp
data.product	string	The product name of related sku
data.currency	string	Sku currency code
data.cost_price	float	Cost price of the Sku
data.price	float	Price of the Sku
data.discounted_price	float	Discounted price of the Sku
data.is_default	boolean	Default Sku indicator
data.last_order_dropped	string	Last order dropped timestamp
data.status	string	Status of the Sku
data.hs_code	string	HS code of the Sku
data.country	string	The country code of the sku
data.expiry_control	boolean	Expiry control flag
data.serial_number_control	boolean	Serial number control flag
alternative_sku_codes	array	List of alternate sku codes

","urlObject":{"path":["api","v3","skus","bulk","update"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[{"id":"f984055b-1880-4c7d-9382-543dd8b7b18a","name":"Update SKU Bulk","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"skus\": [\n {\n \"id\": 195052,\n \"sku_type\": \"Regular\",\n \"sku_number\": \"TESTSKU00334\",\n \"alter_sku_name\": \"ALTTESTSKU00334\",\n \"description\": \"A short test description.\",\n \"brand\": \"IQF\",\n \"category\": \"PANTS\",\n \"sub_category\": \"PANTS\",\n \"weight\": 0,\n \"cubee\": 0,\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"size\": null,\n \"color\": null,\n \"design_number\": null,\n \"currency\": \"AED\",\n \"cost_price\": 0,\n \"price\": 100,\n \"discounted_price\": null,\n \"hs_code\": null,\n \"country\": \"UAE\",\n \"alternative_sku_codes\": [\n \"ALTR001\",\n \"ALTR02\"\n ]\n },\n {\n \"id\": 19505667,\n \"sku_type\": \"Regular\",\n \"sku_number\": \"TESTSKU00335\",\n \"alter_sku_name\": \"ALTTESTSKU00335\",\n \"description\": \"A short test description.\",\n \"brand\": \"IQF\",\n \"category\": \"PANTS\",\n \"sub_category\": \"PANTS\",\n \"weight\": 0,\n \"cubee\": 0,\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"size\": null,\n \"color\": null,\n \"design_number\": null,\n \"currency\": \"AED\",\n \"cost_price\": 0,\n \"price\": 100,\n \"discounted_price\": null,\n \"hs_code\": null,\n \"country\": \"UAE\",\n \"alternative_sku_codes\": [\n \"ALTR001\",\n \"ALTR02\"\n ]\n }\n ]\n}"},"url":"BASE_URL/api/v3/skus/bulk/update"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.25.1"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.2.7"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 19 Oct 2023 09:10:21 GMT"},{"key":"X-RateLimit-Limit","value":"120"},{"key":"X-RateLimit-Remaining","value":"119"},{"key":"Vary","value":"Origin"},{"key":"X-Clockwork-Id","value":"1697706621-5192-1342892598"},{"key":"X-Clockwork-Version","value":"5.1.11"},{"key":"Server-Timing","value":"app; dur=119.41695213318; desc=\"Application\", db; dur=31.91; desc=\"Database\", timeline-event-0; dur=72.880029678345; desc=\"Controller\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"total_count\": 2,\n \"successful_count\": 1,\n \"failed_count\": 1,\n \"failed\": {\n \"TESTSKU00335\": {\n \"id\": [\n \"The selected id is invalid.\"\n ]\n }\n },\n \"successful\": {\n \"TESTSKU00334\": {\n \"id\": 195052,\n \"status\": \"Enabled\",\n \"sku_number\": \"TESTSKU00334\",\n \"alter_sku_name\": \"ALTTESTSKU00334\",\n \"description\": \"A short test description.\",\n \"brand\": \"IQF\",\n \"category\": null,\n \"sub_category\": null,\n \"photo\": null,\n \"weight\": 0,\n \"cubee\": 0,\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"size\": 0,\n \"color\": \"0\",\n \"design_number\": null,\n \"sku_type\": \"Regular\",\n \"order_count\": 0,\n \"system_creation_time\": \"2023-10-19 13:01:51\",\n \"insert_time\": \"2023-10-19 13:01:51\",\n \"product\": null,\n \"currency\": \"AED\",\n \"cost_price\": 0,\n \"price\": 100,\n \"discounted_price\": 0,\n \"is_default\": false,\n \"last_order_dropped\": null,\n \"hs_code\": null,\n \"country\": \"United Arab Emirates\",\n \"expiry_control\": 0,\n \"serial_number_control\": 0\n }\n }\n}"}],"_postman_id":"891f1452-e29e-4916-970f-21bb8fc876a8"}],"id":"b9f9cdf2-ff99-4d6f-a97c-1a5563d36e32","_postman_id":"b9f9cdf2-ff99-4d6f-a97c-1a5563d36e32","description":""},{"name":"Inventory","item":[{"name":"Get","id":"152f4c00-666a-4cb2-9304-1c941df84093","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"per_page\": 10,\n \"page\": 1,\n \"warehouses\": [\n \"WarehouseSystemCode01\",\n \"WarehouseSystemCode02\"\n ],\n \"qty_from\": 10,\n \"qty_to\": 100,\n \"skus\": [\n \"SKUSystemCode01\",\n \"SKUSystemCode02\"\n ]\n}"},"url":"BASE_URL/api/v3/inventory","description":"

Body description:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Example	Type	Validation	Description
page	1	integer	Optional	Page number of pagination. Default value: 1
per_page	50	integer	Optional	Items number on per page. Default value: 50
warehouses	[ \"WarehouseSystemCode01\", \"WarehouseSystemCode02\" ]	array	Optional	Warehouse system codes to filter data.
qty_from	10	integer	Optional	Available quantity lowest value to filter data.
qty_to	100	integer	Optional	Available quantity higest value to filter data.
skus	[\"SKUSystemCode01\", \"SKUSystemCode02\"]	array	Optional	SKU system codes to filter data.

Response description:

Attribute	Type	Description
success	boolean	Status of request.
pagination	object	Pagination data.
pagination.per_page	integer	The number of items to be shown per page. Default 50
pagination.current_page	integer	The current page number. Default 1
pagination.last_page	integer	The last page number.
pagination.total	integer	The total number of rows.
applied_filters	array	The array of applied filters.
applied_filters.warehouses	array	Warehouses which are applied in the filter.
applied_filters.qty_from	integer	Available quantity lowest value which is applied in the filter.
applied_filters.qty_to	integer	Available quantity higest value which is applied in the filter.
applied_filters.skus	array	SKUs which are applied in the filter.
data	array	List of data.
data.*.id	integer	Unique ID number of Inventory
data.*.sku	integer	SKU number of the inventory
data.*.alter_sku	integer	Alternative SKU name of the inventory
data.*.warehouse	integer	Warehouse system code of the inventory
data.*.on_hand_qty	integer	On hand quantity of the inventory
data.*.available_qty	integer	Available quantity of the inventory
data.*.reserved_qty	integer	Reserved quantity of the inventory
data.*.demanded_qty	integer	Demanded quantity of the inventory
data.*.damaged_qty	integer	Damaged quantity of the inventory
data.*.missing_qty	integer	Missing quantity of the inventory

","urlObject":{"path":["api","v3","inventory"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[{"id":"7e621f8b-eaed-49a3-91ab-c6e156275b1d","name":"Get Inventory","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"per_page\": 10,\n \"page\": 1\n}"},"url":"BASE_URL/api/v3/inventory"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 19 Jul 2023 08:40:27 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/8.1.10"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Vary","value":"Authorization,Origin"},{"key":"X-Powered-By","value":"PHP/8.1.10"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"120"},{"key":"X-RateLimit-Remaining","value":"119"},{"key":"X-Clockwork-Id","value":"1689756027-2103-1820525948"},{"key":"X-Clockwork-Version","value":"5.1.11"},{"key":"Server-Timing","value":"app; dur=59.624910354614; desc=\"Application\", db; dur=7.69; desc=\"Database\", timeline-event-0; dur=34.219026565552; desc=\"Controller\""},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"pagination\": {\n \"per_page\": 10,\n \"current_page\": 1,\n \"last_page\": 1039,\n \"total\": 10382\n },\n \"applied_filters\": [],\n \"data\": [\n {\n \"id\": 10590,\n \"sku\": \"5608348130196\",\n \"alter_sku\": null,\n \"warehouse\": \"WarehouseSystemCode001\",\n \"on_hand_qty\": 0,\n \"available_qty\": -1,\n \"reserved_qty\": 0,\n \"demanded_qty\": 1,\n \"damaged_qty\": 0,\n \"missing_qty\": 0\n },\n {\n \"id\": 10589,\n \"sku\": \"5608348051385\",\n \"alter_sku\": null,\n \"warehouse\": \"WarehouseSystemCode001\",\n \"on_hand_qty\": 0,\n \"available_qty\": -1,\n \"reserved_qty\": 0,\n \"demanded_qty\": 1,\n \"damaged_qty\": 0,\n \"missing_qty\": 0\n },\n {\n \"id\": 10588,\n \"sku\": \"5608348149419\",\n \"alter_sku\": null,\n \"warehouse\": \"WarehouseSystemCode001\",\n \"on_hand_qty\": 0,\n \"available_qty\": -1,\n \"reserved_qty\": 0,\n \"demanded_qty\": 1,\n \"damaged_qty\": 0,\n \"missing_qty\": 0\n },\n {\n \"id\": 10587,\n \"sku\": \"5608348054201\",\n \"alter_sku\": null,\n \"warehouse\": \"WarehouseSystemCode001\",\n \"on_hand_qty\": 0,\n \"available_qty\": -1,\n \"reserved_qty\": 0,\n \"demanded_qty\": 1,\n \"damaged_qty\": 0,\n \"missing_qty\": 0\n },\n {\n \"id\": 10586,\n \"sku\": \"5608348130202\",\n \"alter_sku\": null,\n \"warehouse\": \"WarehouseSystemCode001\",\n \"on_hand_qty\": 0,\n \"available_qty\": -1,\n \"reserved_qty\": 0,\n \"demanded_qty\": 1,\n \"damaged_qty\": 0,\n \"missing_qty\": 0\n },\n {\n \"id\": 10585,\n \"sku\": \"5608348067416\",\n \"alter_sku\": null,\n \"warehouse\": \"WarehouseSystemCode001\",\n \"on_hand_qty\": 0,\n \"available_qty\": -1,\n \"reserved_qty\": 0,\n \"demanded_qty\": 1,\n \"damaged_qty\": 0,\n \"missing_qty\": 0\n },\n {\n \"id\": 10584,\n \"sku\": \"5608348138994\",\n \"alter_sku\": null,\n \"warehouse\": \"WarehouseSystemCode001\",\n \"on_hand_qty\": 0,\n \"available_qty\": -1,\n \"reserved_qty\": 0,\n \"demanded_qty\": 1,\n \"damaged_qty\": 0,\n \"missing_qty\": 0\n },\n {\n \"id\": 10583,\n \"sku\": \"5608348083041\",\n \"alter_sku\": null,\n \"warehouse\": \"WarehouseSystemCode001\",\n \"on_hand_qty\": 0,\n \"available_qty\": -1,\n \"reserved_qty\": 0,\n \"demanded_qty\": 1,\n \"damaged_qty\": 0,\n \"missing_qty\": 0\n },\n {\n \"id\": 10582,\n \"sku\": \"5608348045704\",\n \"alter_sku\": null,\n \"warehouse\": \"WarehouseSystemCode001\",\n \"on_hand_qty\": 0,\n \"available_qty\": -1,\n \"reserved_qty\": 0,\n \"demanded_qty\": 1,\n \"damaged_qty\": 0,\n \"missing_qty\": 0\n },\n {\n \"id\": 10581,\n \"sku\": \"5608348075817\",\n \"alter_sku\": null,\n \"warehouse\": \"WarehouseSystemCode001\",\n \"on_hand_qty\": 0,\n \"available_qty\": -1,\n \"reserved_qty\": 0,\n \"demanded_qty\": 1,\n \"damaged_qty\": 0,\n \"missing_qty\": 0\n }\n ]\n}"}],"_postman_id":"152f4c00-666a-4cb2-9304-1c941df84093"}],"id":"6befdcac-5f01-4515-a6c4-30718cba495b","_postman_id":"6befdcac-5f01-4515-a6c4-30718cba495b","description":""},{"name":"ASN","item":[{"name":"Get","id":"0107201f-1eee-42c1-8d5f-712670d8583e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{token}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"page\": 1,\n \"per_page\": 2,\n \"statuses\": [\"confirmed\"],\n \"asn_creation_date_range\": [\"2023-06-15\", \"2023-07-29\"],\n \"asn_receive_date_range\": [\"2023-06-15\", \"2023-07-29\"]\n}"},"url":"BASE_URL/api/v3/asns","description":"

Body description:

Attribute	Example	Type	Validation	Description
page	1	integer	optional	Page number of pagination. Default value: 1
per_page	5	integer	optional	Items number on per page. Default value: 50
asn_types	['ASNVPO00001'] Array	Array	optional	Asn types to filter data.
warehouses	['TESTWAREHOUSE1']	Array	optional	Warehouses systemcode to filter data.
skus	['TESTSKU1']	Array	optional	Sku unique names to filter data.
statuses	['Confirmed']	Array	optional	Statuses system code to filter data. Possible values: Pre-alert Initiated, Confirmed, Partially received, Fully received, On hold, Cancelled, Closed.
carriers	[0,1,2]	Array	optional	Carriers to filter
asn_reference_1	['test']	Array	optional	Asn References to filter
asn_creation_date_range	[\"2023-06-15\", \"2023-07-29\"]	Array(2)	optional	2 date to filter by asn creation date between 2 dates
asn_receive_date_range	[\"2023-06-15\", \"2023-07-29\"]	Array(2)	optional	2 date to filter by asn receive date between 2 dates
asn_number	['test']	Array	optional	Asn number(s) to filter. It can be string
reference_number	['test']	Array	optional	Reference number(s) to filter. It can be string
po_number	['test']	Array	optional	Purchase order number(s) to filter. It can be string

Response description:

Attribute	Type	Description
success	boolean	Status of request.
pagination	object	Pagination data.
pagination.per_page	integer	The number of items to be shown per page. Default 50
pagination.current_page	integer	The current page number. Default 1
pagination.last_page	integer	The last page number.
pagination.total	integer	The total number of rows.
applied_filters	array	The array of applied filters.
applied_filters.asn_number	string	The asn_number which is applied in the filter.
applied_filters.warehouse	string	The warehouse which is applied in the filter.
applied_filters.sku	string	The sku which is applied in the filter.
applied_filters.last_status	string	The status which is applied in the filter.
data	array	List of data.
data.*.id	integer	Unique ID number of ASN.
data.*.warehouse	string	Warehouse systemcode.
data.*.asn_number	string	Unique asn number.
data.*.asn_type	string	Asn type.
data.*.last_status	string	Last status of ASN.
data.*.expected_arrival_time	timestamp	Expected arrival time of ASN.
data.*.actual_arrival_time	timestamp	Actual arrival time of ASN.
data.*.created_at	timestamp	Creation time of ASN.
data.*.receiving_type	string	Receiving type of ASN.
data.*.carrier	string	Carrier of ASN
data.*.reference_number	string	Reference number of ASN.
data.*.po_number	string	PO number of ASN.
data.*.vehicle_number	string	Vehicle number of ASN.
data.*.vehicle_type	string	Vehicle type of ASN.
data.*.invoice_number	string	Invoice number of ASN.
data.*.number_of_boxes	integer	Number of boxes of ASN.
data.*.supplier_reference_code	string	Supplier reference of ASN.
data.*.put_on_hold	boolean	Put ASN on hold.
data.*.note	string	Note of ASN.
data.*.enable_uom_conversion	boolean	Enable UOM Conversation
data.*.skus	array	List of SKUs of ASN. Need to enable it by 'include_skus' => true on request body.
data..skus..sku	string	Unique SKU name.
data..skus..batch_number	string	Batch number of ASN SKU.
data..skus..carton_number	string	Carton number of ASN SKU.
data..skus..expected_qty	integer	Expected quantity of ASN SKU.
data..skus..received_qty	integer	Received quantity of ASN SKU.
data..skus..label_flag	boolean	Require labeling of ASN SKU.
data..skus..bundle_flag	boolean	Require bundling of ASN SKU.
data..skus..qc_flag	boolean	Require quality control of ASN SKU.
data..skus..assemble_flag	boolean	Require assembling of ASN SKU.
data..skus..transfer_flag	boolean	Transferable SKU of ASN.
data..skus..exp_date	date	Expiry date of ASN SKU.
data..skus..uom	string	UOM
data..skus..uom_quantity	Integer	Quantity of UOM
data.*.status_history	array	Status history list of ASN. Need to enable it by 'include_status_history' => true on request body.
data..status_history..status_id	integer	Status unique ID number.
data..status_history..label	string	Title of status.
data..status_history..timestamp	timestamp	Status date.
data..status_history..note	string	Note of status.

","urlObject":{"path":["api","v3","asns"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[{"id":"89d1ff2a-3a41-437b-8c84-6e329cb4b5a5","name":"Get ASNs","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"page\": 1,\n \"per_page\": 2,\n \"include_skus\": true\n}"},"url":"BASE_URL/api/v3/asns"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Jul 2023 10:18:02 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/8.1.10"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Vary","value":"Authorization,Origin"},{"key":"X-Powered-By","value":"PHP/8.1.10"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"120"},{"key":"X-RateLimit-Remaining","value":"119"},{"key":"X-Clockwork-Id","value":"1689675482-1084-1884370379"},{"key":"X-Clockwork-Version","value":"5.1.11"},{"key":"Server-Timing","value":"app; dur=62.870025634766; desc=\"Application\", db; dur=6.37; desc=\"Database\", timeline-event-0; dur=35.526037216187; desc=\"Controller\""},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"pagination\": {\n \"per_page\": 2,\n \"current_page\": 1,\n \"last_page\": 88,\n \"total\": 175\n },\n \"applied_filters\": [],\n \"data\": [\n {\n \"id\": 184,\n \"warehouse\": \"IMTIAZB2B\",\n \"asn_number\": \"ASNVPO000170\",\n \"asn_type\": \"VPO\",\n \"last_status\": \"Confirmed\",\n \"last_status_time\": \"2023-07-18T08:11:37.000000Z\",\n \"expected_arrival_time\": \"2023-07-05T20:00:00.000000Z\",\n \"actual_arrival_time\": null,\n \"created_at\": \"2023-07-18T08:11:37.000000Z\",\n \"receiving_type\": \"Bulk\",\n \"carrier\": null,\n \"reference_number\": null,\n \"po_number\": null,\n \"vehicle_number\": null,\n \"vehicle_type\": null,\n \"invoice_number\": null,\n \"number_of_boxes\": null,\n \"supplier_reference_code\": null,\n \"put_on_hold\": false,\n \"note\": \"Test Note\",\n \"enable_uom_conversion\": true,\n \"skus\": [\n {\n \"sku\": \"TRANSFERSKU1\",\n \"batch_number\": null,\n \"carton_number\": \"CAPIC2\",\n \"expected_qty\": 101,\n \"received_qty\": 0,\n \"label_flag\": false,\n \"bundle_flag\": false,\n \"qc_flag\": false,\n \"assemble_flag\": false,\n \"transfer_flag\": false,\n \"exp_date\": null,\n \"uom\": \"CF\",\n \"uom_quantity\": 5\n },\n {\n \"sku\": \"TRANSFERSKU3\",\n \"batch_number\": null,\n \"carton_number\": \"CAPIC2\",\n \"expected_qty\": 103,\n \"received_qty\": 0,\n \"label_flag\": false,\n \"bundle_flag\": false,\n \"qc_flag\": false,\n \"assemble_flag\": false,\n \"transfer_flag\": false,\n \"exp_date\": null,\n \"uom\": \"CF\",\n \"uom_quantity\": 5\n }\n ]\n },\n {\n \"id\": 183,\n \"warehouse\": \"IMTIAZB2B\",\n \"asn_number\": \"ASNVPO000169\",\n \"asn_type\": \"VPO\",\n \"last_status\": \"Fully received\",\n \"last_status_time\": \"2023-07-15T10:09:52.000000Z\",\n \"expected_arrival_time\": \"2023-07-14T20:00:00.000000Z\",\n \"actual_arrival_time\": null,\n \"created_at\": \"2023-07-15T10:05:45.000000Z\",\n \"receiving_type\": \"Carton\",\n \"carrier\": null,\n \"reference_number\": null,\n \"po_number\": null,\n \"vehicle_number\": null,\n \"vehicle_type\": null,\n \"invoice_number\": null,\n \"number_of_boxes\": null,\n \"supplier_reference_code\": null,\n \"put_on_hold\": false,\n \"note\": null,\n \"enable_uom_conversion\": true,\n \"skus\": [\n {\n \"sku\": \"TESTPERFSKU1019\",\n \"batch_number\": null,\n \"carton_number\": \"B10\",\n \"expected_qty\": 11,\n \"received_qty\": 11,\n \"label_flag\": false,\n \"bundle_flag\": false,\n \"qc_flag\": false,\n \"assemble_flag\": false,\n \"transfer_flag\": true,\n \"exp_date\": null,\n \"uom\": \"CF\",\n \"uom_quantity\": 5\n }\n ]\n }\n ]\n}"}],"_postman_id":"0107201f-1eee-42c1-8d5f-712670d8583e"},{"name":"Create","id":"9cce7d5e-2945-4dbf-81e9-810d75df1250","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"warehouse\": \"IMTIAZB2B\",\n \"carrier\": null,\n \"supplier_reference_code\": null,\n \"expected_arrival_time\": \"2023-07-06 00:00:00\",\n \"po_number\": null,\n \"vehicle_number\": null,\n \"vehicle_type\": null,\n \"invoice_number\": null,\n \"number_of_boxes\": null,\n \"actual_arrival_time\": null,\n \"note\": \"Test Note\",\n \"asn_type\": \"VPO\",\n \"receiving_type\": \"Bulk\",\n \"put_on_hold\": false,\n \"skus\": [\n {\n \"sku_barcode\": \"TRANSFERSKU1\",\n \"batch_number\": null,\n \"carton_number\": \"CAPIC2\",\n \"expected_qty\": 101,\n \"label_flag\": false,\n \"bundle_flag\": false,\n \"qc_flag\": false,\n \"assemble_flag\": false,\n \"exp_date\": null,\n \"transfer_flag\": false\n }\n ]\n}"},"url":"BASE_URL/api/v3/asns/create","description":"

Body description:

Attribute	Example	Type	Validation	Description
warehouse	TESTWAREHOUSE1	string	required exists in warehouse.	Warehouse systemcode.
carrier	Test Carrier	string	optional freetext	Sku unique name to filter data.
supplier_reference_code	SRC001	string	optional freetext	Supplier reference code of ASN.
expected_arrival_time	2023-07-06 00:00:00	timestamp	required format: Y-m-d H:i:s	Expected arrival time of ASN.
po_number	PO001	string	optional freetext	PO number of ASN.
vehicle_number	VN001	string	optional freetext	Vehicle number of ASN.
vehicle_type	Truck	string	optional freetext	Vehicle type of ASN.
invoice_number	IN001	string	optional freetext	Invoice number of ASN.
number_of_boxes	10	integer	optional	Number of boxes of ASN.
actual_arrival_time	2023-07-06 00:00:00	timestamp	optional format: Y-m-d H:i:s	Actual arrival time of ASN.
note	Test note	string	optional freetext	Note of ASN.
asn_type	VPO	string	required exists in possible values.	Type of ASN. Possible values: VPO, CR, RS, SR, EX.
receiving_type	Carton	string	required exists in possible values.	Receiving type of ASN. Possible values: By scanning each, Bulk, Carton.
put_on_hold	false	boolean	required	Put ASN on hold.
enable_uom_conversion	false	boolean	optional	Enable UOM conversation
skus	[ {...}, {...} ]	array	required	List of SKUs of ASN.
skus.*.sku_barcode	TESTSKU1	string	required exists in SKU for this customer.	Unique SKU name.
skus.*.batch_number	BN001	string	optional freetext	Batch number of ASN SKU.
skus.*.carton_number	CN01	string	required if receiving_type => carton, otherwise optional	Carton number of ASN SKU.
skus.*.expected_qty	100	integer	required	Expected quantity of ASN SKU.
skus.*.label_flag	false	boolean	required	Require labeling of ASN SKU.
skus.*.bundle_flag	false	boolean	required	Require bundling of ASN SKU.
skus.*.qc_flag	false	boolean	required	Require quality control of ASN SKU.
skus.*.assemble_flag	false	boolean	required	Require assembling of ASN SKU.
skus.*.transfer_flag	false	boolean	required	Transferable SKU of ASN.
skus.*.exp_date	2023-07-18	date	optional format: Y-m-d	Expiry date of ASN SKU.
skus.*.uom	CF	string	optional	UOM
skus.*.uom_quantity	1	integer		Quantity

Response description:

Attribute	Type	Description
success	boolean	Status of request.
data	object	Inserted ASN data.
data.id	integer	Unique ID number of ASN.
data.warehouse	string	Warehouse systemcode.
data.asn_number	string	Unique asn number.
data.asn_type	string	Asn type.
data.last_status	string	Last status of ASN.
data.expected_arrival_time	timestamp	Expected arrival time of ASN.
data.actual_arrival_time	timestamp	Actual arrival time of ASN.
data.created_at	timestamp	Creation time of ASN.
data.receiving_type	string	Receiving type of ASN.
data.carrier	string	Carrier of ASN
data.reference_number	string	Reference number of ASN.
data.po_number	string	PO number of ASN.
data.vehicle_number	string	Vehicle number of ASN.
data.vehicle_type	string	Vehicle type of ASN.
data.invoice_number	string	Invoice number of ASN.
data.number_of_boxes	integer	Number of boxes of ASN.
data.supplier_reference_code	string	Supplier reference of ASN.
data.put_on_hold	boolean	Put ASN on hold.
data.note	string	Note of ASN.
enable_uom_conversion	boolean	enable uom conversion
data.skus	array	List of SKUs of ASN.
data.skus.*.sku	string	Unique SKU name.
data.skus.*.batch_number	string	Batch number of ASN SKU.
data.skus.*.carton_number	string	Carton number of ASN SKU.
data.skus.*.expected_qty	integer	Expected quantity of ASN SKU.
data.skus.*.received_qty	integer	Received quantity of ASN SKU.
data.skus.*.label_flag	boolean	Require labeling of ASN SKU.
data.skus.*.bundle_flag	boolean	Require bundling of ASN SKU.
data.skus.*.qc_flag	boolean	Require quality control of ASN SKU.
data.skus.*.assemble_flag	boolean	Require assembling of ASN SKU.
data.skus.*.transfer_flag	boolean	Transferable SKU of ASN.
data.skus.*.exp_date	date	Expiry date of ASN SKU.
data.skus.*.uom	string	UOM
data.skus.*.uom_quantity	integer	Quantity of UOM
data.status_history	array	Status history list of ASN.
data.status_history.*.status_id	integer	Status unique ID number.
data.status_history.*.label	string	Title of status.
data.status_history.*.timestamp	timestamp	Status date.
data.status_history.*.note	string	Note of status.

","urlObject":{"path":["api","v3","asns","create"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[{"id":"704e169d-2709-414d-9a9b-e6dfe745788d","name":"Create ASN","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"warehouse\": \"IMTIAZB2B\",\n \"carrier\": null,\n \"supplier_reference_code\": null,\n \"expected_arrival_time\": \"2023-07-06 00:00:00\",\n \"po_number\": null,\n \"vehicle_number\": null,\n \"vehicle_type\": null,\n \"invoice_number\": null,\n \"number_of_boxes\": null,\n \"actual_arrival_time\": null,\n \"note\": \"Test Note\",\n \"asn_type\": \"VPO\",\n \"receiving_type\": \"Bulk\",\n \"put_on_hold\": false,\n \"enable_uom_conversion\": true,\n \"skus\": [\n {\n \"sku_barcode\": \"TRANSFERSKU1\",\n \"batch_number\": null,\n \"carton_number\": \"CAPIC2\",\n \"expected_qty\": 101,\n \"label_flag\": false,\n \"bundle_flag\": false,\n \"qc_flag\": false,\n \"assemble_flag\": false,\n \"exp_date\": null,\n \"transfer_flag\": false,\n \"uom\": \"CF\",\n \"uom_quantity\": 5\n },\n {\n \"sku_barcode\": \"TRANSFERSKU3\",\n \"batch_number\": null,\n \"carton_number\": \"CAPIC2\",\n \"expected_qty\": 103,\n \"label_flag\": false,\n \"bundle_flag\": false,\n \"qc_flag\": false,\n \"assemble_flag\": false,\n \"exp_date\": null,\n \"transfer_flag\": false,\n \"uom\": \"CF\",\n \"uom_quantity\": 5\n }\n ]\n}"},"url":"BASE_URL/api/v3/asns/create"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Jul 2023 08:11:37 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/8.1.10"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Vary","value":"Authorization,Origin"},{"key":"X-Powered-By","value":"PHP/8.1.10"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"120"},{"key":"X-RateLimit-Remaining","value":"119"},{"key":"X-Clockwork-Id","value":"1689667897-6573-673527674"},{"key":"X-Clockwork-Version","value":"5.1.11"},{"key":"Server-Timing","value":"app; dur=109.50398445129; desc=\"Application\", db; dur=16.32; desc=\"Database\", timeline-event-0; dur=75.189113616943; desc=\"Controller\""},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 184,\n \"warehouse\": \"IMTIAZB2B\",\n \"asn_number\": \"ASNVPO000170\",\n \"asn_type\": \"VPO\",\n \"last_status\": \"Confirmed\",\n \"last_status_time\": \"2023-07-18T08:11:37.000000Z\",\n \"expected_arrival_time\": \"2023-07-05T20:00:00.000000Z\",\n \"actual_arrival_time\": null,\n \"created_at\": \"2023-07-18T08:11:37.000000Z\",\n \"receiving_type\": \"Bulk\",\n \"carrier\": null,\n \"reference_number\": null,\n \"po_number\": null,\n \"vehicle_number\": null,\n \"vehicle_type\": null,\n \"invoice_number\": null,\n \"number_of_boxes\": null,\n \"supplier_reference_code\": null,\n \"put_on_hold\": false,\n \"note\": \"Test Note\",\n \"enable_uom_conversion\": true,\n \"skus\": [\n {\n \"sku\": \"TRANSFERSKU1\",\n \"batch_number\": null,\n \"carton_number\": \"CAPIC2\",\n \"expected_qty\": 101,\n \"received_qty\": 0,\n \"label_flag\": false,\n \"bundle_flag\": false,\n \"qc_flag\": false,\n \"assemble_flag\": false,\n \"transfer_flag\": false,\n \"exp_date\": null,\n \"uom\": \"CF\",\n \"uom_quantity\": 5\n },\n {\n \"sku\": \"TRANSFERSKU3\",\n \"batch_number\": null,\n \"carton_number\": \"CAPIC2\",\n \"expected_qty\": 103,\n \"received_qty\": 0,\n \"label_flag\": false,\n \"bundle_flag\": false,\n \"qc_flag\": false,\n \"assemble_flag\": false,\n \"transfer_flag\": false,\n \"exp_date\": null,\n \"uom\": \"CF\",\n \"uom_quantity\": 5\n }\n ],\n \"status_history\": [\n {\n \"status_id\": 500,\n \"label\": \"Confirmed\",\n \"timestamp\": \"2023-07-18T08:11:37.000000Z\",\n \"note\": \"\"\n }\n ]\n }\n}"}],"_postman_id":"9cce7d5e-2945-4dbf-81e9-810d75df1250"},{"name":"Create Bulk","id":"af72f9b3-f119-470d-bac1-33ced312420b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"asn\":[\n {\n \"warehouse\": \"IMTIAZB2B\",\n \"carrier\": null,\n \"supplier_reference_code\": null,\n \"expected_arrival_time\": \"2023-07-06 00:00:00\",\n \"po_number\": null,\n \"vehicle_number\": null,\n \"vehicle_type\": null,\n \"invoice_number\": null,\n \"number_of_boxes\": null,\n \"actual_arrival_time\": null,\n \"note\": \"Test Note\",\n \"asn_type\": \"VPO\",\n \"receiving_type\": \"Bulk\",\n \"put_on_hold\": false,\n \"skus\": [\n {\n \"sku_barcode\": \"TRANSFERSKU1\",\n \"batch_number\": null,\n \"carton_number\": \"CAPIC2\",\n \"expected_qty\": 101,\n \"label_flag\": false,\n \"bundle_flag\": false,\n \"qc_flag\": false,\n \"assemble_flag\": false,\n \"exp_date\": null,\n \"transfer_flag\": false\n }\n ]\n }\n ]\n}"},"url":"BASE_URL/api/v3/asns/bulk","description":"

Body description:

Attribute	Example	Type	Validation	Description
warehouse	TESTWAREHOUSE1	string	required exists in warehouse.	Warehouse systemcode.
carrier	Test Carrier	string	optional freetext	Sku unique name to filter data.
supplier_reference_code	SRC001	string	optional freetext	Supplier reference code of ASN.
expected_arrival_time	2023-07-06 00:00:00	timestamp	required format: Y-m-d H:i:s	Expected arrival time of ASN.
po_number	PO001	string	optional freetext	PO number of ASN.
vehicle_number	VN001	string	optional freetext	Vehicle number of ASN.
vehicle_type	Truck	string	optional freetext	Vehicle type of ASN.
invoice_number	IN001	string	optional freetext	Invoice number of ASN.
number_of_boxes	10	integer	optional	Number of boxes of ASN.
actual_arrival_time	2023-07-06 00:00:00	timestamp	optional format: Y-m-d H:i:s	Actual arrival time of ASN.
note	Test note	string	optional freetext	Note of ASN.
asn_type	VPO	string	required exists in possible values.	Type of ASN. Possible values: VPO, CR, RS, SR, EX.
receiving_type	Carton	string	required exists in possible values.	Receiving type of ASN. Possible values: By scanning each, Bulk, Carton.
put_on_hold	false	boolean	required	Put ASN on hold.
skus	[ {...}, {...} ]	array	required	List of SKUs of ASN.
skus.*.sku_barcode	TESTSKU1	string	required exists in SKU for this customer.	Unique SKU name.
skus.*.batch_number	BN001	string	optional freetext	Batch number of ASN SKU.
skus.*.carton_number	CN01	string	required if receiving_type => carton, otherwise optional	Carton number of ASN SKU.
skus.*.expected_qty	100	integer	required	Expected quantity of ASN SKU.
skus.*.label_flag	false	boolean	required	Require labeling of ASN SKU.
skus.*.bundle_flag	false	boolean	required	Require bundling of ASN SKU.
skus.*.qc_flag	false	boolean	required	Require quality control of ASN SKU.
skus.*.assemble_flag	false	boolean	required	Require assembling of ASN SKU.
skus.*.transfer_flag	false	boolean	required	Transferable SKU of ASN.
skus.*.exp_date	2023-07-18	date	optional format: Y-m-d	Expiry date of ASN SKU.

Response description:

Attribute	Type	Description
success	boolean	Status of request.
data	object	Inserted ASN data.
data.id	integer	Unique ID number of ASN.
data.warehouse	string	Warehouse systemcode.
data.asn_number	string	Unique asn number.
data.asn_type	string	Asn type.
data.last_status	string	Last status of ASN.
data.expected_arrival_time	timestamp	Expected arrival time of ASN.
data.actual_arrival_time	timestamp	Actual arrival time of ASN.
data.created_at	timestamp	Creation time of ASN.
data.receiving_type	string	Receiving type of ASN.
data.carrier	string	Carrier of ASN
data.reference_number	string	Reference number of ASN.
data.po_number	string	PO number of ASN.
data.vehicle_number	string	Vehicle number of ASN.
data.vehicle_type	string	Vehicle type of ASN.
data.invoice_number	string	Invoice number of ASN.
data.number_of_boxes	integer	Number of boxes of ASN.
data.supplier_reference_code	string	Supplier reference of ASN.
data.put_on_hold	boolean	Put ASN on hold.
data.note	string	Note of ASN.
data.skus	array	List of SKUs of ASN.
data.skus.*.sku	string	Unique SKU name.
data.skus.*.batch_number	string	Batch number of ASN SKU.
data.skus.*.carton_number	string	Carton number of ASN SKU.
data.skus.*.expected_qty	integer	Expected quantity of ASN SKU.
data.skus.*.received_qty	integer	Received quantity of ASN SKU.
data.skus.*.label_flag	boolean	Require labeling of ASN SKU.
data.skus.*.bundle_flag	boolean	Require bundling of ASN SKU.
data.skus.*.qc_flag	boolean	Require quality control of ASN SKU.
data.skus.*.assemble_flag	boolean	Require assembling of ASN SKU.
data.skus.*.transfer_flag	boolean	Transferable SKU of ASN.
data.skus.*.exp_date	date	Expiry date of ASN SKU.
data.status_history	array	Status history list of ASN.
data.status_history.*.status_id	integer	Status unique ID number.
data.status_history.*.label	string	Title of status.
data.status_history.*.timestamp	timestamp	Status date.
data.status_history.*.note	string	Note of status.

","urlObject":{"path":["api","v3","asns","bulk"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[{"id":"d6da776d-b564-4e3e-8eeb-7d2882b7af99","name":"Create ASN","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"warehouse\": \"IMTIAZB2B\",\n \"carrier\": null,\n \"supplier_reference_code\": null,\n \"expected_arrival_time\": \"2023-07-06 00:00:00\",\n \"po_number\": null,\n \"vehicle_number\": null,\n \"vehicle_type\": null,\n \"invoice_number\": null,\n \"number_of_boxes\": null,\n \"actual_arrival_time\": null,\n \"note\": \"Test Note\",\n \"asn_type\": \"VPO\",\n \"receiving_type\": \"Bulk\",\n \"put_on_hold\": false,\n \"skus\": [\n {\n \"sku_barcode\": \"TRANSFERSKU1\",\n \"batch_number\": null,\n \"carton_number\": \"CAPIC2\",\n \"expected_qty\": 101,\n \"label_flag\": false,\n \"bundle_flag\": false,\n \"qc_flag\": false,\n \"assemble_flag\": false,\n \"exp_date\": null,\n \"transfer_flag\": false\n },\n {\n \"sku_barcode\": \"TRANSFERSKU3\",\n \"batch_number\": null,\n \"carton_number\": \"CAPIC2\",\n \"expected_qty\": 103,\n \"label_flag\": false,\n \"bundle_flag\": false,\n \"qc_flag\": false,\n \"assemble_flag\": false,\n \"exp_date\": null,\n \"transfer_flag\": false\n }\n ]\n}"},"url":"BASE_URL/api/v3/asns/create"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Jul 2023 08:11:37 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/8.1.10"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Vary","value":"Authorization,Origin"},{"key":"X-Powered-By","value":"PHP/8.1.10"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"120"},{"key":"X-RateLimit-Remaining","value":"119"},{"key":"X-Clockwork-Id","value":"1689667897-6573-673527674"},{"key":"X-Clockwork-Version","value":"5.1.11"},{"key":"Server-Timing","value":"app; dur=109.50398445129; desc=\"Application\", db; dur=16.32; desc=\"Database\", timeline-event-0; dur=75.189113616943; desc=\"Controller\""},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 184,\n \"warehouse\": \"IMTIAZB2B\",\n \"asn_number\": \"ASNVPO000170\",\n \"asn_type\": \"VPO\",\n \"last_status\": \"Confirmed\",\n \"last_status_time\": \"2023-07-18T08:11:37.000000Z\",\n \"expected_arrival_time\": \"2023-07-05T20:00:00.000000Z\",\n \"actual_arrival_time\": null,\n \"created_at\": \"2023-07-18T08:11:37.000000Z\",\n \"receiving_type\": \"Bulk\",\n \"carrier\": null,\n \"reference_number\": null,\n \"po_number\": null,\n \"vehicle_number\": null,\n \"vehicle_type\": null,\n \"invoice_number\": null,\n \"number_of_boxes\": null,\n \"supplier_reference_code\": null,\n \"put_on_hold\": false,\n \"note\": \"Test Note\",\n \"skus\": [\n {\n \"sku\": \"TRANSFERSKU1\",\n \"batch_number\": null,\n \"carton_number\": \"CAPIC2\",\n \"expected_qty\": 101,\n \"received_qty\": 0,\n \"label_flag\": false,\n \"bundle_flag\": false,\n \"qc_flag\": false,\n \"assemble_flag\": false,\n \"transfer_flag\": false,\n \"exp_date\": null\n },\n {\n \"sku\": \"TRANSFERSKU3\",\n \"batch_number\": null,\n \"carton_number\": \"CAPIC2\",\n \"expected_qty\": 103,\n \"received_qty\": 0,\n \"label_flag\": false,\n \"bundle_flag\": false,\n \"qc_flag\": false,\n \"assemble_flag\": false,\n \"transfer_flag\": false,\n \"exp_date\": null\n }\n ],\n \"status_history\": [\n {\n \"status_id\": 500,\n \"label\": \"Confirmed\",\n \"timestamp\": \"2023-07-18T08:11:37.000000Z\",\n \"note\": \"\"\n }\n ]\n }\n}"}],"_postman_id":"af72f9b3-f119-470d-bac1-33ced312420b"}],"id":"a639cd86-a431-4960-bed2-4bf810ca5ae3","description":"

ASN Module.

\n","_postman_id":"a639cd86-a431-4960-bed2-4bf810ca5ae3"},{"name":"Returns","item":[{"name":"Create Return","id":"1c806683-0cfc-46ea-bf7d-63b3eb89f368","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{token}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"source_of_order\": \"External\", //IQ Fulfillment, External\n \"client_reference\": \"test00240620\", //for external it is required\n \"return_type\": \"Reverse Pick\",\n \"destination_warehouse\": \"IQWH01\",\n \"original_client_reference\": \"test00240620\",\n \"original_order_number\": \"test00240620\",\n \"original_awb\": \"test00240620\",\n \"currency\": \"AED\",\n \"amount\": 100,\n \"carrier\": null,\n \"comment\": \"Test Comment.\",\n \"expected_collection_date\": \"2024-07-01\",\n \"parcel\": {\n \"number_of_boxes\": 1,\n \"total_weight\": 1,\n \"length\": 1,\n \"width\": 1,\n \"height\": 1\n },\n \"skus\": [\n {\n \"line_no\": 1,\n \"code\": \"200G\",\n \"quantity\": 2,\n \"serials\": [\n \"1234\",\n \"4567\"\n ]\n }\n ],\n \"collection_address_type\": \"Custom Address\", //End customer,Custom Address\n \"collection_address\": {\n \"name\": \"My address\",\n \"phone\": \"12345678\",\n \"country\": \"UAE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"area\": \"\",\n \"postal_code\": \"\",\n \"address\": \"WAREHOUSE NO. 5, PLOT NO. 5981298111\",\n \"address_2\": \"WAREHOUSE NO. 5, PLOT NO. 5981298111\"\n },\n \"destination_address_type\": \"Custom Address\", //Warehouse,Custom Address\n \"destination_address\": {\n \"name\": \"My address\",\n \"phone\": \"12345678\",\n \"country\": \"UAE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"area\": \"\",\n \"postal_code\": \"\",\n \"address\": \"WAREHOUSE NO. 5, PLOT NO. 5981298111\",\n \"address_2\": \"WAREHOUSE NO. 5, PLOT NO. 5981298111\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"BASE_URL/api/v3/orders","description":"

Body description:

Attribute	Example	Type	Validation	Description
source_of_order	External or IQ Fulfillment	String	Required Unique Without Spaces Max: 20	Client reference for order.
client_reference	RVP0001	String	Required Unique Without Spaces Max: 20	Client reference for returns and if source_of_order is External, it is mandatory.
return_type	Reverse Pick, Return To Origin	String	Required	Return types for returns
destination_warehouse	IQWH01	String	Required	Return warehouse to receive.
original_client_reference	CUS00001	String	Optional Required if return type is IQ Fulfillment	Related order reference.
original_order_number	IQF000023456	String	Optional Required if return type is IQ Fulfillment	Related order's order number.
original_awb	CAR0012345	String	Optional Required if return type is IQ Fulfillment	Related order's AWB number.
currency	AED	String	Optional	Currency code of return order.
amount	100	Numeric	Optional	Value of amount to collect.
carrier	DHL	String	Optional Required if return type is External	Carrier code for tracking.
expected_collection_date	\"2024-07-01\"	String	Optional	Expected collection date for return.
skus	[ { 'line_no':1, 'code': 'CODE1', 'quantity':1, 'serials':[ \"123\"4, \"2345\" ] }, ]	Array	Required	Array of SKUs for the return.
skus.*.code	858936006838	String	Required	SKU code. Please, check the skus on extra information menu.
skus.*.quantity	1	Numeric	Required Greater than 0	Quantity of the SKU.
skus.*.line_no	1	Numeric	Optional	Lile no of the SKU.
skus.*.serials	[ \"123\"4, \"2345\" ]	Array	Optional	Serials numbers of the SKU.
parcel	{ \"number_of_boxes\": 1, \"total_weight\": 1, \"length\": 1, \"width\": 1, \"height\": 1 }	Array	Required	Parcel information for the return.
parcel.number_of_boxes	1	Numeric	Required	Number of boxes.
parcel.total_weight	1	Numeric	Optional	Total weight of the return order.
parcel.length	1	Numeric	Optional	Total length of the return order boxes.
parcel.width	1	Numeric	Optional	Total width of the return order boxes.
parcel.height	1	Numeric	Optional	Total height of the return order boxes.
collection_address_type	End customer or Custom Address	String	Required	Address type for collection. End customer: only for IQF order related returns. we will consider the address of related orders shipping address. Custom Address: if you want to configure new address.
collection_address		Array	Required if collection_address_type is Custom Address	Collection address details.
collection_address.country	USA	String	Required Min:2, Max:3	ISO2 or ISO3 name for the shipping country. Possible values: USA, ALB. Please, check the countries on extra information menu.
collection_address.state	Aseer	String	Required Max:30	Shipping state. Possible values: Al Khobar, Aseer. Please, check the states on extra information menu.
collection_address.city	Al Khobar	String	Required Max:30	Shipping city. Possible values: Mahayel, Al Khobar. Please, check the cities on extra information menu.
collection_address.area	Muscat	String	Optional Max:50	Shipping area. Possible values: Muscat. Please, check the areas on extra information menu.
collection_address.address_1	Address 1	String	Required Max:255	Shipping address line 1.
collection_address.address_2	Address	String	Optional Max:255	Shipping address line 2.
collection_address.postal_code	3215	String	Optional	Postal code.
destination_address_type	Warehouse or Custom Address	String	Required	Address type for receiving. Warehouse: we will consider the address of destination warehouse. Custom Address: if you want to configure new address.
destination_address		Array	Required if collection_address_type is Custom Address	Destination address details.
destination_address.country	USA	String	Required Min:2, Max:3	ISO2 or ISO3 name for the shipping country. Possible values: USA, ALB. Please, check the countries on extra information menu.
destination_address.state	Aseer	String	Required Max:30	Shipping state. Possible values: Al Khobar, Aseer. Please, check the states on extra information menu.
destination_address.city	Al Khobar	String	Required Max:30	Shipping city. Possible values: Mahayel, Al Khobar. Please, check the cities on extra information menu.
destination_address.area	Muscat	String	Optional Max:50	Shipping area. Possible values: Muscat. Please, check the areas on extra information menu.
destination_address.address_1	Address 1	String	Required Max:255	Shipping address line 1.
destination_address.address_2	Address	String	Optional Max:255	Shipping address line 2.
destination_address.postal_code	3215	String	Optional	Postal code.

Response description:

Attribute	Type	Description
success	Boolean	Status of request.
pagination	Object	Pagination data.
pagination.per_page	integer	The number of items to be shown per page. Default 50
pagination.current_page	integer	The current page number. Default 1
pagination.last_page	integer	The last page number.
pagination.total	integer	The total number of rows.
applied_filters	Array	The array of applied filters.
applied_filters.carriers	Array	The carriers which are applied in the filter.
applied_filters.awb	Array	The awb which are applied in the filter.
applied_filters.status	Array	The status which are applied in the filter.
applied_filters.return_types	Array	The return types which are applied in the filter.
applied_filters.warehouses	Array	The warehouses which are applied in the filter.
applied_filters.skus	Array	The skus which are applied in the filter.
applied_filters.return_creation_date_range	Array	The order creation date range which is applied in the filter.
data.*.id	Numeric	The unique ID of the order.
data.*.source_of_order	String	The source of order for the return.
data.*.return_type	String	The type of the return.
data.*.client_reference	String	The client reference for the return.
data.*.warehouse	String	The warehouse system code for the return order.
data.*.delivery_no	String	The Airway Bill number for delivery, if available.
data.*.original_order_no	String	The original order number, if available.
data.*.original_client_reference	String	The original order's client reference number.
data.*.original_awb	String	The original return's AWB number.
data.*.order_id	Numeric	The original orders's ID number if the return is a IQF order return.
data.*.comment	String	Additional comments about the return order.
data.*.amount	decimal	The price of the return order.
data.*.currency	String	The currency of the amount.
data.*.expected_collection_date	String	The timestamp when the return order was expected to collect.
data.*.parcel.total_weight	Numeric	Total weight of the parcel.
data.*.parcel.total_volume	Numeric	Total volume of the parcel.
data.*.parcel.number_of_boxes	Numeric	Number of boxes in the parcel.
data.*.last_status	String	The label of the current order status.
data.*.last_status_time	String	The timestamp of the current current order status.
data.*.last_status_details	String	Comment about the current return order status.
data.*.shipping_label_url	String	The shipping label url of the return order if available.
data.*.skus	Array	An array of SKUs included in the return order.
data..skus..alternate_sku_name	String	Alternate name for the SKU.
data..skus..quantity	Numeric	The quantity of the SKU in the order.
data.*.collection_address_type	String	The collection address type of return order.
data.*.collection_address	String	The collection address type of return order.
data..collection_address..company	String	The company name of collection address if available.
data..collection_address..name	String	The name of the contact person.
data..collection_address..surname	String	The surname of the contact person if available.
data..collection_address..phone	String	The phone of the contact person.
data..collection_address..country	String	The country of the return collection address.
data..collection_address..state	String	The state of the return collection address.
data..collection_address..city	String	The city of the return collection address.
data..collection_address..area	String	The area of the return collection address if available.
data..collection_address..address	String	The address of the return collection address.
data..collection_address..address_2	String	The address line 2 of the return collection address if available.
data..collection_address..postal_code	String	The postal_code of the return collection address if available.
data.*.destination_address_type	String	The destination address type of return order.
data..destination_address..company	String	The company name of destination address if available.
data..destination_address..name	String	The name of the contact person.
data..destination_address..surname	String	The surname of the contact person if available.
data..destination_address..phone	String	The phone of the contact person.
data..destination_address..country	String	The country of the return destination address.
data..destination_address..state	String	The state of the return destination address.
data..destination_address..city	String	The city of the return destination address.
data..destination_address..area	String	The area of the return destination address if available.
data..destination_address..address	String	The address of the return destination address.
data..destination_address..address_2	String	The address line 2 of the return destination address if available.
data..destination_address..postal_code	String	The postal_code of the return destination address if available.

","urlObject":{"path":["api","v3","orders"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[{"id":"03b9f676-aec2-42cc-aa2c-0317052b18c3","name":"Create Return (External)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"source_of_order\": \"External\", //IQ Fulfillment, External\n \"client_reference\": \"RVP00120240702\", //for external it is required\n \"return_type\": \"Reverse Pick\",\n \"destination_warehouse\": \"IQWH01\",\n \"original_client_reference\": \"ORG00120240702\",\n \"original_order_number\": \"ORG00120240702\",\n \"original_awb\": \"AWB00120240702\",\n \"currency\": \"AED\",\n \"amount\": 100,\n \"carrier\": null,\n \"comment\": \"Test Comment.\",\n \"expected_collection_date\": \"2024-07-01\",\n \"parcel\": {\n \"number_of_boxes\": 1,\n \"total_weight\": 1,\n \"length\": 1,\n \"width\": 1,\n \"height\": 1\n },\n \"skus\": [\n {\n \"line_no\": 1,\n \"code\": \"200G\",\n \"quantity\": 2,\n \"serials\": [\n \"1234\",\n \"4567\"\n ]\n }\n ],\n \"collection_address_type\": \"Custom Address\", //End customer,Custom Address\n \"collection_address\": {\n \"name\": \"My address\",\n \"phone\": \"12345678\",\n \"country\": \"UAE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"area\": \"\",\n \"postal_code\": \"\",\n \"address\": \"WAREHOUSE NO. 5, PLOT NO. 5981298111\",\n \"address_2\": \"WAREHOUSE NO. 5, PLOT NO. 5981298111\"\n },\n \"destination_address_type\": \"Custom Address\", //Warehouse,Custom Address\n \"destination_address\": {\n \"name\": \"My address\",\n \"phone\": \"12345678\",\n \"country\": \"UAE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"area\": \"\",\n \"postal_code\": \"\",\n \"address\": \"WAREHOUSE NO. 5, PLOT NO. 5981298111\",\n \"address_2\": \"WAREHOUSE NO. 5, PLOT NO. 5981298111\"\n }\n}"},"url":"BASE_URL/api/v3/returns/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Jul 2024 08:35:51 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/8.1.26"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Vary","value":"Authorization,Origin"},{"key":"X-Powered-By","value":"PHP/8.1.26"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"120"},{"key":"X-RateLimit-Remaining","value":"119"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 320,\n \"source_of_order\": \"External\",\n \"client_reference\": \"RVP00120240702\",\n \"warehouse\": \"IQWH01\",\n \"return_type\": \"Reverse Pick\",\n \"order_id\": null,\n \"original_client_reference\": \"ORG00120240702\",\n \"original_order_number\": \"ORG00120240702\",\n \"original_awb\": \"AWB00120240702\",\n \"currency\": \"AED\",\n \"carrier\": null,\n \"system_order_number\": null,\n \"delivery_no\": null,\n \"comment\": \"Test Comment.\",\n \"amount\": 100,\n \"expected_collection_date\": \"2024-07-01 00:00:00\",\n \"last_status\": \"Confirmed\",\n \"last_status_time\": \"01-07-2024 00:00:00\",\n \"last_status_details\": null,\n \"shipping_label_url\": null,\n \"skus\": [\n {\n \"code\": \"200G\",\n \"alter_sku_name\": \"N200G\",\n \"quantity\": 2,\n \"line_no\": 1\n }\n ],\n \"parcel\": {\n \"number_of_boxes\": 1,\n \"total_weight\": \"1\",\n \"length\": \"1\",\n \"width\": \"1\",\n \"height\": \"1\"\n },\n \"collection_address_type\": \"Custom Address\",\n \"collection_address\": {\n \"id\": 537,\n \"company\": null,\n \"name\": \"My address\",\n \"surname\": null,\n \"phone\": \"12345678\",\n \"country\": \"UAE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"area\": null,\n \"address\": \"WAREHOUSE NO. 5, PLOT NO. 5981298111\",\n \"address_2\": \"WAREHOUSE NO. 5, PLOT NO. 5981298111\",\n \"postal_code\": null\n },\n \"destination_address_type\": \"Custom Address\",\n \"destination_address\": {\n \"id\": 538,\n \"company\": null,\n \"name\": \"My address\",\n \"surname\": null,\n \"phone\": \"12345678\",\n \"country\": \"UAE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"area\": null,\n \"address\": \"WAREHOUSE NO. 5, PLOT NO. 5981298111\",\n \"address_2\": \"WAREHOUSE NO. 5, PLOT NO. 5981298111\",\n \"postal_code\": null\n }\n }\n}"},{"id":"0be8d6e3-20ff-4080-ad81-f5fb1e0eb11b","name":"Create Return (IQ Fulfillment)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"source_of_order\": \"IQ Fulfillment\", //IQ Fulfillment, External\n \"return_type\": \"Reverse Pick\",\n \"destination_warehouse\": \"IQWH01\",\n \"original_client_reference\": \"TEST107986725\",\n \"original_order_number\": \"TEST107986725\",\n \"original_awb\": \"IQD-47602434\",\n \"currency\": \"AED\",\n \"carrier\": null,\n \"comment\": \"Test Comment.\",\n \"expected_collection_date\": \"2024-07-01\",\n \"parcel\": {\n \"number_of_boxes\": 1,\n \"total_weight\": 1,\n \"length\": 1,\n \"width\": 1,\n \"height\": 1\n },\n \"skus\": [\n {\n \"line_no\": 1,\n \"code\": \"200G\",\n \"quantity\": 2\n }\n ],\n \"collection_address_type\": \"End customer\", //End customer,Custom Address\n \"destination_address_type\": \"Custom Address\", //Warehouse,Custom Address\n \"destination_address\": {\n \"name\": \"My address\",\n \"phone\": \"12345678\",\n \"country\": \"UAE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"area\": \"\",\n \"postal_code\": \"\",\n \"address\": \"WAREHOUSE NO. 5, PLOT NO. 5981298111\",\n \"address_2\": \"WAREHOUSE NO. 5, PLOT NO. 5981298111\"\n }\n}"},"url":"BASE_URL/api/v3/returns/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Jul 2024 08:41:40 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/8.1.26"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Vary","value":"Authorization,Origin"},{"key":"X-Powered-By","value":"PHP/8.1.26"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"120"},{"key":"X-RateLimit-Remaining","value":"119"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 321,\n \"source_of_order\": \"IQ Fulfillment\",\n \"client_reference\": \"GSCRVP1198327\",\n \"warehouse\": \"IQWH01\",\n \"return_type\": \"Reverse Pick\",\n \"order_id\": 1198327,\n \"original_client_reference\": \"TEST107986725\",\n \"original_order_number\": \"TEST107986725\",\n \"original_awb\": \"IQD-47602434\",\n \"currency\": \"AED\",\n \"carrier\": \"TRANSCORP\",\n \"system_order_number\": null,\n \"delivery_no\": null,\n \"comment\": \"Test Comment.\",\n \"amount\": 150,\n \"expected_collection_date\": \"2024-07-01 00:00:00\",\n \"last_status\": \"Confirmed\",\n \"last_status_time\": \"01-07-2024 00:00:00\",\n \"last_status_details\": null,\n \"shipping_label_url\": null,\n \"skus\": [\n {\n \"code\": \"200G\",\n \"alter_sku_name\": \"N200G\",\n \"quantity\": 2,\n \"line_no\": 1\n }\n ],\n \"parcel\": {\n \"number_of_boxes\": 1,\n \"total_weight\": \"1\",\n \"length\": \"1\",\n \"width\": \"1\",\n \"height\": \"1\"\n },\n \"collection_address_type\": \"Custom Address\",\n \"collection_address\": {\n \"id\": 539,\n \"company\": null,\n \"name\": \"First Last Name\",\n \"surname\": null,\n \"phone\": \"97151234567\",\n \"country\": \"UAE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"area\": null,\n \"address\": \"Shop #13 , Yasmeen Bldg 1, Industial Are 6, SHJ, near Dubai Islamic Bank Industial Are 6 \",\n \"address_2\": \"Shop #13 , Yasmeen Bldg 1, Industial Are 6, SHJ, near Dubai Islamic Bank Industial Are 6 \",\n \"postal_code\": \"\"\n },\n \"destination_address_type\": \"Custom Address\",\n \"destination_address\": {\n \"id\": 540,\n \"company\": null,\n \"name\": \"My address\",\n \"surname\": null,\n \"phone\": \"12345678\",\n \"country\": \"UAE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"area\": null,\n \"address\": \"WAREHOUSE NO. 5, PLOT NO. 5981298111\",\n \"address_2\": \"WAREHOUSE NO. 5, PLOT NO. 5981298111\",\n \"postal_code\": null\n }\n }\n}"},{"id":"0c1bcd45-2da5-4648-a408-b8c50d078e91","name":"Create Return (With Instant AWB)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"source_of_order\": \"External\", //IQ Fulfillment, External\n \"client_reference\": \"RVP00120240701\", //for external it is required\n \"return_type\": \"Reverse Pick\",\n \"destination_warehouse\": \"IQWH01\",\n \"original_client_reference\": \"ORG00120240701\",\n \"original_order_number\": \"ORG00120240701\",\n \"original_awb\": \"AWB00120240701\",\n \"currency\": \"AED\",\n \"amount\": 100,\n \"carrier\": null,\n \"comment\": \"Test Comment.\",\n \"expected_collection_date\": \"2024-07-01\",\n \"parcel\": {\n \"number_of_boxes\": 1,\n \"total_weight\": 1,\n \"length\": 1,\n \"width\": 1,\n \"height\": 1\n },\n \"skus\": [\n {\n \"line_no\": 1,\n \"code\": \"200G\",\n \"quantity\": 2,\n \"serials\": [\n \"1234\",\n \"4567\"\n ]\n }\n ],\n \"collection_address_type\": \"Custom Address\", //End customer,Custom Address\n \"collection_address\": {\n \"name\": \"My address\",\n \"phone\": \"12345678\",\n \"country\": \"UAE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"area\": \"\",\n \"postal_code\": \"\",\n \"address\": \"WAREHOUSE NO. 5, PLOT NO. 5981298111\",\n \"address_2\": \"WAREHOUSE NO. 5, PLOT NO. 5981298111\"\n },\n \"destination_address_type\": \"Warehouse\" //Warehouse,Custom Address\n}"},"url":"BASE_URL/api/v3/returns/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Jul 2024 08:30:04 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/8.1.26"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Vary","value":"Authorization,Origin"},{"key":"X-Powered-By","value":"PHP/8.1.26"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"120"},{"key":"X-RateLimit-Remaining","value":"119"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 319,\n \"source_of_order\": \"External\",\n \"client_reference\": \"RVP00120240701\",\n \"warehouse\": \"IQWH01\",\n \"return_type\": \"Reverse Pick\",\n \"order_id\": null,\n \"original_client_reference\": \"ORG00120240701\",\n \"original_order_number\": \"ORG00120240701\",\n \"original_awb\": \"AWB00120240701\",\n \"currency\": \"AED\",\n \"carrier\": \"ECOFREIGHT\",\n \"system_order_number\": null,\n \"delivery_no\": \"ECO0003732140\",\n \"comment\": \"Test Comment.\",\n \"amount\": 100,\n \"expected_collection_date\": \"2024-07-01 00:00:00\",\n \"last_status\": \"Confirmed\",\n \"last_status_time\": \"01-07-2024 00:00:00\",\n \"last_status_details\": null,\n \"shipping_label_url\": null,\n \"skus\": [\n {\n \"code\": \"200G\",\n \"alter_sku_name\": \"N200G\",\n \"quantity\": 2,\n \"line_no\": 1\n }\n ],\n \"parcel\": {\n \"number_of_boxes\": 1,\n \"total_weight\": \"1\",\n \"length\": \"1\",\n \"width\": \"1\",\n \"height\": \"1\"\n },\n \"collection_address_type\": \"Custom Address\",\n \"collection_address\": {\n \"id\": 536,\n \"company\": null,\n \"name\": \"My address\",\n \"surname\": null,\n \"phone\": \"12345678\",\n \"country\": \"UAE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"area\": null,\n \"address\": \"WAREHOUSE NO. 5, PLOT NO. 5981298111\",\n \"address_2\": \"WAREHOUSE NO. 5, PLOT NO. 5981298111\",\n \"postal_code\": null\n },\n \"destination_address_type\": \"Warehouse\",\n \"destination_address\": {\n \"id\": 223,\n \"company\": \"IQ Fulfillment\",\n \"name\": \"IQ Fulfillment\",\n \"surname\": null,\n \"phone\": \"96623241267\",\n \"country\": \"UAE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"area\": null,\n \"address\": \"Warehouse #5\",\n \"address_2\": null,\n \"postal_code\": null\n }\n }\n}"}],"_postman_id":"1c806683-0cfc-46ea-bf7d-63b3eb89f368"},{"name":"Get Returns","id":"8ff146da-0afe-4c2b-91d1-4b43be800d71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{token}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"page\": 1,\n \"per_page\": 2,\n \"warehouses\":[\"WRH1\",\"WRH2\"],\n \"carriers\":[\"car1\",\"car2\"],\n \"return_types\": [\"Reverse Pick\"],\n \"awb\":[\"awb1\",\"awb2\"],\n \"skus\":[\"sku1\",\"sku2\"],\n \"return_creation_date_range\": [\"2023-06-15\", \"2023-07-21\"]\n}","options":{"raw":{"language":"json"}}},"url":"BASE_URL/api/v3/orders","description":"

Body description:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Example	Type	Validation	Description
per_page	10	Numeric	Optional	The number of results per page. Defaults to 50. If include_status_history is set to true and per_page is greater than 20 then it will be set to 10.
page	1	Numeric	Required	The page number.
carriers	[\"car1\",\"car2\"]	Array	Optional	An array of carrier IDs. Only returns with the specified carrier IDs will be returned.
awb	[\"awb1\",\"awb2\"]	Array	Optional	An array of AWB numbers. Only returns with the specified AWB numbers will be returned.
status	[\"Confirmed\",\"Pending\"]	Array	Optional	An array of status labels. Only returns with the specified statuses will be returned.
return_types	[\"Reverse Pick\",\"Return To Origin\"]	Array	Optional	An array of return types. Only returns with the specified return types will be returned.
warehouses	[\"WRH1\",\"WRH2\"]	Array	Optional	An array of warehouse system codes. Only orders with the specified warehouse system codes will be returned.
skus	[\"SKU1\",\"SKU2\"]	Array	Optional	An array of SKU codes. Only returns that contain the specified SKUs will be returned.
return_creation_date_range	[\"12-12-2023 12:12:12\",\"15-12-2023 12:12:12\"]	Array	Optional	An array of two timestamps representing the start and end dates of the returns creation date range. Only returns that were created within the specified date range will be returned.

Response description:

Attribute	Type	Description
success	Boolean	Status of request.
pagination	Object	Pagination data.
pagination.per_page	integer	The number of items to be shown per page. Default 50
pagination.current_page	integer	The current page number. Default 1
pagination.last_page	integer	The last page number.
pagination.total	integer	The total number of rows.
applied_filters	Array	The array of applied filters.
applied_filters.carriers	Array	The carriers which are applied in the filter.
applied_filters.awb	Array	The awb which are applied in the filter.
applied_filters.status	Array	The status which are applied in the filter.
applied_filters.return_types	Array	The return types which are applied in the filter.
applied_filters.warehouses	Array	The warehouses which are applied in the filter.
applied_filters.skus	Array	The skus which are applied in the filter.
applied_filters.return_creation_date_range	Array	The order creation date range which is applied in the filter.
data.*.id	Numeric	The unique ID of the order.
data.*.source_of_order	String	The source of order for the return.
data.*.return_type	String	The type of the return.
data.*.client_reference	String	The client reference for the return.
data.*.warehouse	String	The warehouse system code for the return order.
data.*.delivery_no	String	The Airway Bill number for delivery, if available.
data.*.original_order_no	String	The original order number, if available.
data.*.original_client_reference	String	The original order's client reference number.
data.*.original_awb	String	The original return's AWB number.
data.*.order_id	Numeric	The original orders's ID number if the return is a IQF order return.
data.*.comment	String	Additional comments about the return order.
data.*.amount	decimal	The price of the return order.
data.*.currency	String	The currency of the amount.
data.*.expected_collection_date	String	The timestamp when the return order was expected to collect.
data.*.parcel.total_weight	Numeric	Total weight of the parcel.
data.*.parcel.total_volume	Numeric	Total volume of the parcel.
data.*.parcel.number_of_boxes	Numeric	Number of boxes in the parcel.
data.*.last_status	String	The label of the current order status.
data.*.last_status_time	String	The timestamp of the current current order status.
data.*.last_status_details	String	Comment about the current return order status.
data.*.shipping_label_url	String	The shipping label url of the return order if available.
data.*.skus	Array	An array of SKUs included in the return order.
data..skus..alternate_sku_name	String	Alternate name for the SKU.
data..skus..quantity	Numeric	The quantity of the SKU in the order.
data.*.collection_address_type	String	The collection address type of return order.
data.*.collection_address	String	The collection address type of return order.
data..collection_address..company	String	The company name of collection address if available.
data..collection_address..name	String	The name of the contact person.
data..collection_address..surname	String	The surname of the contact person if available.
data..collection_address..phone	String	The phone of the contact person.
data..collection_address..country	String	The country of the return collection address.
data..collection_address..state	String	The state of the return collection address.
data..collection_address..city	String	The city of the return collection address.
data..collection_address..area	String	The area of the return collection address if available.
data..collection_address..address	String	The address of the return collection address.
data..collection_address..address_2	String	The address line 2 of the return collection address if available.
data..collection_address..postal_code	String	The postal_code of the return collection address if available.
data.*.destination_address_type	String	The destination address type of return order.
data..destination_address..company	String	The company name of destination address if available.
data..destination_address..name	String	The name of the contact person.
data..destination_address..surname	String	The surname of the contact person if available.
data..destination_address..phone	String	The phone of the contact person.
data..destination_address..country	String	The country of the return destination address.
data..destination_address..state	String	The state of the return destination address.
data..destination_address..city	String	The city of the return destination address.
data..destination_address..area	String	The area of the return destination address if available.
data..destination_address..address	String	The address of the return destination address.
data..destination_address..address_2	String	The address line 2 of the return destination address if available.
data..destination_address..postal_code	String	The postal_code of the return destination address if available.

","urlObject":{"path":["api","v3","orders"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[{"id":"f36d78a2-67e4-4f8c-b6bf-28f2337950b5","name":"Get Returns","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"per_page\": 10,\n \"page\": 1,\n //\"warehouses\": [\"Warehouse1\"],\n //\"carriers\": [\"QUIQUP\"],\n \"return_creation_date_range\": [\"2023-06-15\", \"2023-07-21\"]\n}"},"url":"BASE_URL/api/v3/returns"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 27 Jun 2024 08:44:08 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/8.1.26"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Vary","value":"Authorization,Origin"},{"key":"X-Powered-By","value":"PHP/8.1.26"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"120"},{"key":"X-RateLimit-Remaining","value":"119"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"pagination\": {\n \"per_page\": 10,\n \"current_page\": 1,\n \"last_page\": 1,\n \"total\": 7\n },\n \"applied_filters\": {\n \"return_creation_date_range\": [\n \"2023-06-15\",\n \"2023-07-21\"\n ]\n },\n \"data\": [\n {\n \"id\": 91,\n \"source_of_order\": \"External\",\n \"client_reference\": \"Test001\",\n \"warehouse\": null,\n \"return_type\": \"Reverse Pick\",\n \"order_id\": 60232,\n \"original_client_reference\": \"1234567\",\n \"original_order_number\": null,\n \"original_awb\": \"1234567\",\n \"currency\": \"AED\",\n \"carrier\": null,\n \"system_order_number\": null,\n \"delivery_no\": null,\n \"comment\": \"s\",\n \"amount\": 300,\n \"expected_collection_date\": \"2023-06-24 00:00:00\",\n \"last_status\": \"Created\",\n \"last_status_time\": \"24-06-2023 00:00:00\",\n \"last_status_details\": null,\n \"shipping_label_url\": null,\n \"skus\": [\n {\n \"code\": \"IQH-CAP-04-0003\",\n \"alter_sku_name\": null,\n \"quantity\": 1,\n \"line_no\": 1\n },\n {\n \"code\": \"BIRYANI\",\n \"alter_sku_name\": \"\",\n \"quantity\": 4,\n \"line_no\": 2\n },\n {\n \"code\": \"GSCSKU01\",\n \"alter_sku_name\": null,\n \"quantity\": 4,\n \"line_no\": 3\n },\n {\n \"code\": \"GSCSKUKSA\",\n \"alter_sku_name\": \"\",\n \"quantity\": 3,\n \"line_no\": 4\n }\n ],\n \"parcel\": {\n \"number_of_boxes\": 1,\n \"total_weight\": null,\n \"length\": null,\n \"width\": null,\n \"height\": null\n },\n \"collection_address_type\": \"Custom Address\",\n \"collection_address\": {\n \"id\": 307,\n \"company\": \"test\",\n \"name\": \"test\",\n \"surname\": null,\n \"phone\": \"1234567\",\n \"country\": \"UAE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"area\": null,\n \"address\": \"test\",\n \"address_2\": null,\n \"postal_code\": null\n },\n \"destination_address_type\": \"Warehouse\",\n \"destination_address\": {\n \"id\": 139,\n \"company\": null,\n \"name\": null,\n \"surname\": null,\n \"phone\": null,\n \"country\": \"KSA\",\n \"state\": null,\n \"city\": null,\n \"area\": null,\n \"address\": null,\n \"address_2\": null,\n \"postal_code\": null\n }\n },\n {\n \"id\": 86,\n \"source_of_order\": \"External\",\n \"client_reference\": \"jhgvjhg\",\n \"warehouse\": null,\n \"return_type\": \"Refund\",\n \"order_id\": 60232,\n \"original_client_reference\": \"sdfsfs\",\n \"original_order_number\": null,\n \"original_awb\": \"1esds\",\n \"currency\": \"AED\",\n \"carrier\": \"test_courier\",\n \"system_order_number\": null,\n \"delivery_no\": \"asdfasdf\",\n \"comment\": \"sdfsdf\",\n \"amount\": 300,\n \"expected_collection_date\": \"2023-06-28 05:00:00\",\n \"last_status\": \"Created\",\n \"last_status_time\": \"28-06-2023 05:00:00\",\n \"last_status_details\": null,\n \"shipping_label_url\": null,\n \"skus\": [\n {\n \"code\": \"200G\",\n \"alter_sku_name\": \"N200G\",\n \"quantity\": 11,\n \"line_no\": null\n }\n ],\n \"parcel\": {\n \"number_of_boxes\": 1,\n \"total_weight\": null,\n \"length\": \"1\",\n \"width\": null,\n \"height\": \"1\"\n },\n \"collection_address_type\": \"Custom Address\",\n \"collection_address\": {\n \"id\": 305,\n \"company\": \"sdf\",\n \"name\": \"sdfs\",\n \"surname\": null,\n \"phone\": \"+971 50 790 9812\",\n \"country\": \"UAE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"area\": null,\n \"address\": \"sdfd\",\n \"address_2\": \"sdf\",\n \"postal_code\": null\n },\n \"destination_address_type\": \"Carrier\",\n \"destination_address\": {\n \"id\": 250,\n \"company\": \"SMSA\",\n \"name\": \"test\",\n \"surname\": \"alma\",\n \"phone\": \"5631232\",\n \"country\": \"UAE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"area\": \"AL AWEER\",\n \"address\": \"home 1\",\n \"address_2\": null,\n \"postal_code\": \"00000\"\n }\n },\n {\n \"id\": 84,\n \"source_of_order\": \"IQ Fulfillment\",\n \"client_reference\": \"GSCRTO1194263\",\n \"warehouse\": \"IQWH01\",\n \"return_type\": \"Return To Origin\",\n \"order_id\": 60232,\n \"original_client_reference\": \"TEST00000675\",\n \"original_order_number\": null,\n \"original_awb\": \"0\",\n \"currency\": \"AED\",\n \"carrier\": \"BFL COURIER\",\n \"system_order_number\": null,\n \"delivery_no\": \"uygi8\",\n \"comment\": null,\n \"amount\": 300,\n \"expected_collection_date\": null,\n \"last_status\": \"Created\",\n \"last_status_time\": \"27-06-2024 12:44:08\",\n \"last_status_details\": null,\n \"shipping_label_url\": null,\n \"skus\": [\n {\n \"code\": \"200G\",\n \"alter_sku_name\": \"N200G\",\n \"quantity\": 1,\n \"line_no\": null\n }\n ],\n \"parcel\": {\n \"number_of_boxes\": null,\n \"total_weight\": null,\n \"length\": null,\n \"width\": null,\n \"height\": null\n },\n \"collection_address_type\": \"Carrier\",\n \"collection_address\": {\n \"id\": 250,\n \"company\": \"SMSA\",\n \"name\": \"test\",\n \"surname\": \"alma\",\n \"phone\": \"5631232\",\n \"country\": \"UAE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"area\": \"AL AWEER\",\n \"address\": \"home 1\",\n \"address_2\": null,\n \"postal_code\": \"00000\"\n },\n \"destination_address_type\": \"Warehouse\",\n \"destination_address\": {\n \"id\": 139,\n \"company\": null,\n \"name\": null,\n \"surname\": null,\n \"phone\": null,\n \"country\": \"KSA\",\n \"state\": null,\n \"city\": null,\n \"area\": null,\n \"address\": null,\n \"address_2\": null,\n \"postal_code\": null\n }\n },\n {\n \"id\": 72,\n \"source_of_order\": \"External\",\n \"client_reference\": \"TestREF001\",\n \"warehouse\": null,\n \"return_type\": \"Return To Origin\",\n \"order_id\": 60232,\n \"original_client_reference\": \"Test0011122\",\n \"original_order_number\": null,\n \"original_awb\": \"Test0011122\",\n \"currency\": \"AED\",\n \"carrier\": null,\n \"system_order_number\": null,\n \"delivery_no\": null,\n \"comment\": \"test\",\n \"amount\": 300,\n \"expected_collection_date\": null,\n \"last_status\": \"Created\",\n \"last_status_time\": \"27-06-2024 12:44:08\",\n \"last_status_details\": null,\n \"shipping_label_url\": null,\n \"skus\": [\n {\n \"code\": \"200G\",\n \"alter_sku_name\": \"N200G\",\n \"quantity\": 2,\n \"line_no\": null\n },\n {\n \"code\": \"230122426\",\n \"alter_sku_name\": null,\n \"quantity\": 4,\n \"line_no\": null\n }\n ],\n \"parcel\": {\n \"number_of_boxes\": 1,\n \"total_weight\": \"4\",\n \"length\": \"1\",\n \"width\": null,\n \"height\": \"1\"\n },\n \"collection_address_type\": \"Custom Address\",\n \"collection_address\": {\n \"id\": 304,\n \"company\": \"Test\",\n \"name\": \"Test\",\n \"surname\": null,\n \"phone\": \"12345678\",\n \"country\": \"UAE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"area\": \"AL AWEER\",\n \"address\": \"Sector X road Y\",\n \"address_2\": null,\n \"postal_code\": null\n },\n \"destination_address_type\": \"Warehouse\",\n \"destination_address\": {\n \"id\": 139,\n \"company\": null,\n \"name\": null,\n \"surname\": null,\n \"phone\": null,\n \"country\": \"KSA\",\n \"state\": null,\n \"city\": null,\n \"area\": null,\n \"address\": null,\n \"address_2\": null,\n \"postal_code\": null\n }\n },\n {\n \"id\": 71,\n \"source_of_order\": \"External\",\n \"client_reference\": \"TEST002\",\n \"warehouse\": null,\n \"return_type\": \"Return To Origin\",\n \"order_id\": 60232,\n \"original_client_reference\": \"TEST002222\",\n \"original_order_number\": null,\n \"original_awb\": \"TEST002222\",\n \"currency\": \"AED\",\n \"carrier\": \"ALMA\",\n \"system_order_number\": null,\n \"delivery_no\": null,\n \"comment\": null,\n \"amount\": 300,\n \"expected_collection_date\": \"2023-06-22 00:00:00\",\n \"last_status\": \"Created\",\n \"last_status_time\": \"22-06-2023 00:00:00\",\n \"last_status_details\": null,\n \"shipping_label_url\": null,\n \"skus\": [\n {\n \"code\": \"100.100.11\",\n \"alter_sku_name\": null,\n \"quantity\": 2,\n \"line_no\": null\n }\n ],\n \"parcel\": {\n \"number_of_boxes\": 1,\n \"total_weight\": null,\n \"length\": \"1\",\n \"width\": null,\n \"height\": null\n },\n \"collection_address_type\": \"Custom Address\",\n \"collection_address\": {\n \"id\": 303,\n \"company\": \"Test\",\n \"name\": \"TEST\",\n \"surname\": null,\n \"phone\": \"012345678\",\n \"country\": \"UAE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"area\": null,\n \"address\": \"shop 33 dubai\",\n \"address_2\": null,\n \"postal_code\": null\n },\n \"destination_address_type\": \"Customer Warehouse Address\",\n \"destination_address\": {\n \"id\": 226,\n \"company\": null,\n \"name\": \"asa\",\n \"surname\": \"as\",\n \"phone\": \"23283\",\n \"country\": \"ALG\",\n \"state\": \"'Ayn Tamushanat\",\n \"city\": \"'Ayn Tamushanat\",\n \"area\": null,\n \"address\": \"asa\",\n \"address_2\": null,\n \"postal_code\": \"3232\"\n }\n },\n {\n \"id\": 69,\n \"source_of_order\": \"External\",\n \"client_reference\": \"TEST0012\",\n \"warehouse\": null,\n \"return_type\": \"Return To Origin\",\n \"order_id\": 60232,\n \"original_client_reference\": \"TEST0012\",\n \"original_order_number\": null,\n \"original_awb\": \"TEST0012\",\n \"currency\": \"AED\",\n \"carrier\": null,\n \"system_order_number\": null,\n \"delivery_no\": null,\n \"comment\": null,\n \"amount\": 300,\n \"expected_collection_date\": \"2023-06-17 00:00:00\",\n \"last_status\": \"Created\",\n \"last_status_time\": \"17-06-2023 00:00:00\",\n \"last_status_details\": null,\n \"shipping_label_url\": null,\n \"skus\": [\n {\n \"code\": \"34272331\",\n \"alter_sku_name\": null,\n \"quantity\": 2,\n \"line_no\": null\n }\n ],\n \"parcel\": {\n \"number_of_boxes\": 1,\n \"total_weight\": null,\n \"length\": \"1\",\n \"width\": null,\n \"height\": null\n },\n \"collection_address_type\": \"Custom Address\",\n \"collection_address\": {\n \"id\": 302,\n \"company\": \"Test\",\n \"name\": \"Test\",\n \"surname\": null,\n \"phone\": \"1234567\",\n \"country\": \"UAE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"area\": \"ABU HAIL\",\n \"address\": \"test\",\n \"address_2\": null,\n \"postal_code\": null\n },\n \"destination_address_type\": \"Warehouse\",\n \"destination_address\": {\n \"id\": 139,\n \"company\": null,\n \"name\": null,\n \"surname\": null,\n \"phone\": null,\n \"country\": \"KSA\",\n \"state\": null,\n \"city\": null,\n \"area\": null,\n \"address\": null,\n \"address_2\": null,\n \"postal_code\": null\n }\n },\n {\n \"id\": 62,\n \"source_of_order\": \"External\",\n \"client_reference\": \"TEST0011\",\n \"warehouse\": null,\n \"return_type\": \"Reverse Pick\",\n \"order_id\": 60232,\n \"original_client_reference\": \"Test0011\",\n \"original_order_number\": null,\n \"original_awb\": \"Test0011\",\n \"currency\": \"AED\",\n \"carrier\": null,\n \"system_order_number\": null,\n \"delivery_no\": null,\n \"comment\": null,\n \"amount\": 300,\n \"expected_collection_date\": \"2023-06-16 00:00:00\",\n \"last_status\": null,\n \"last_status_time\": \"16-06-2023 00:00:00\",\n \"last_status_details\": null,\n \"shipping_label_url\": null,\n \"skus\": [\n {\n \"code\": \"693685111\",\n \"alter_sku_name\": null,\n \"quantity\": 1,\n \"line_no\": null\n }\n ],\n \"parcel\": {\n \"number_of_boxes\": 1,\n \"total_weight\": \"1\",\n \"length\": \"11\",\n \"width\": null,\n \"height\": \"1\"\n },\n \"collection_address_type\": \"Custom Address\",\n \"collection_address\": {\n \"id\": 296,\n \"company\": \"Test\",\n \"name\": \"Test Address\",\n \"surname\": null,\n \"phone\": \"12345678\",\n \"country\": \"UAE\",\n \"state\": \"Dubai\",\n \"city\": \"Dubai\",\n \"area\": \"AL BADA\",\n \"address\": \"test oo 12\",\n \"address_2\": null,\n \"postal_code\": null\n },\n \"destination_address_type\": \"Warehouse\",\n \"destination_address\": {\n \"id\": 218,\n \"company\": \"Jenkins-Zboncak\",\n \"name\": \"Ms. Twila Hickle\",\n \"surname\": \"Prohaska\",\n \"phone\": \"+19417538400\",\n \"country\": \"ANG\",\n \"state\": \"Aiga-i-le-Tai\",\n \"city\": \"Matsumoto\",\n \"area\": \"Al Khaboura\",\n \"address\": \"9279 McDermott Drive\\nSouth Tristianton, NC 49471\",\n \"address_2\": \"1362 Burley Mill Apt. 551\\nTatyanamouth, NH 43153\",\n \"postal_code\": \"17173-8540\"\n }\n }\n ]\n}"}],"_postman_id":"8ff146da-0afe-4c2b-91d1-4b43be800d71"}],"id":"10e6da1f-b197-4a36-a7ed-49b39fa034ea","_postman_id":"10e6da1f-b197-4a36-a7ed-49b39fa034ea","description":""},{"name":"WebHooks","item":[{"name":"Order Status Update","item":[{"name":"Payload of Order Status Update Webhook","id":"00778eaa-f111-449c-979c-9e5613cb9e64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 1,\n \"awb\": \"IQF-TEST\",\n \"skus\": [\n {\n \"sku\": \"12345678\",\n \"price\": \"25.00\",\n \"line_no\": 116806057,\n \"serials\": [],\n \"quantity\": 1,\n \"description\": \"SMART COLOUR EYESHADOW 05\",\n \"discounted_price\": 0,\n \"alternate_sku_name\": \"KM000000380005B\"\n }\n ],\n \"price\": 25,\n \"parcel\": {\n \"total_volume\": 0,\n \"total_weight\": 0.02,\n \"number_of_boxes\": 1\n },\n \"address\": {\n \"area\": \"Al Mizhar 3\",\n \"city\": \"DUBAI\",\n \"town\": null,\n \"route\": \"DXB\",\n \"state\": \"Dubai\",\n \"address\": \"Al mizhar 3 55 Al Mizhar 3,AL MIZHAR 3\",\n \"country\": \"UAE\",\n \"zipcode\": null,\n \"province\": \"DUBAI\"\n },\n \"carrier\": \"Carrier_Name\",\n \"comment\": \"\",\n \"currency\": \"AED\",\n \"consignee\": {\n \"name\": \"Jhone Doe\",\n \"email\": \"email@gmail.com\",\n \"phone\": \"01234567\",\n \"mobile\": \"01234567\"\n },\n \"warehouse\": \"IQWH01\",\n \"cod_amount\": 0,\n \"order_type\": \"Fulfillment\",\n \"tax_amount\": 0,\n \"gift_message\": null,\n \"order_number\": \"IQFIQF007619\",\n \"payment_type\": \"Prepaid\",\n \"shipped_time\": \"2024-10-20 15:32:34\",\n \"tracking_link\": \"https://track.iqfulfillment.com/?iqf=IQF-TEST\",\n \"current_status\": {\n \"date\": {\n \"date\": \"2024-10-22 16:02:20\",\n \"in_seconds\": 1729598540\n },\n \"status\": \"Delivered\",\n \"comment\": \"\",\n \"status_id\": 100\n },\n \"customs_amount\": 23.81,\n \"delivered_time\": \"2024-10-22 16:02:20\",\n \"shipping_price\": 0,\n \"status_history\": [\n {\n \"date\": {\n \"date\": \"2024-10-22 16:02:20\",\n \"in_seconds\": 1729598540\n },\n \"status\": \"Delivered\",\n \"comment\": \"\",\n \"status_id\": 100\n },\n {\n \"date\": {\n \"date\": \"2024-10-22 14:24:15\",\n \"in_seconds\": 1729592655\n },\n \"status\": \"Out for Delivery\",\n \"comment\": \"\",\n \"status_id\": 80\n },\n {\n \"date\": {\n \"date\": \"2024-10-21 13:46:27\",\n \"in_seconds\": 1729503987\n },\n \"status\": \"Exception\",\n \"comment\": \"Incomplete address and customer not responding\",\n \"status_id\": 90\n },\n {\n \"date\": {\n \"date\": \"2024-10-21 06:11:48\",\n \"in_seconds\": 1729476708\n },\n \"status\": \"Out for Delivery\",\n \"comment\": \"\",\n \"status_id\": 80\n },\n {\n \"date\": {\n \"date\": \"2024-10-20 16:59:49\",\n \"in_seconds\": 1729429189\n },\n \"status\": \"In Transit\",\n \"comment\": \"\",\n \"status_id\": 75\n },\n {\n \"date\": {\n \"date\": \"2024-10-20 15:32:34\",\n \"in_seconds\": 1729423954\n },\n \"status\": \"Shipped\",\n \"comment\": \"\",\n \"status_id\": 60\n },\n {\n \"date\": {\n \"date\": \"2024-10-20 13:27:32\",\n \"in_seconds\": 1729416452\n },\n \"status\": \"Packed\",\n \"comment\": \"\",\n \"status_id\": 50\n },\n {\n \"date\": {\n \"date\": \"2024-10-20 12:39:20\",\n \"in_seconds\": 1729413560\n },\n \"status\": \"Picked\",\n \"comment\": \"\",\n \"status_id\": 30\n },\n {\n \"date\": {\n \"date\": \"2024-10-20 08:11:01\",\n \"in_seconds\": 1729397461\n },\n \"status\": \"Allocated\",\n \"comment\": \"\",\n \"status_id\": 12\n },\n {\n \"date\": {\n \"date\": \"2024-10-20 08:07:10\",\n \"in_seconds\": 1729397230\n },\n \"status\": \"Confirmed\",\n \"comment\": null,\n \"status_id\": 10\n }\n ],\n \"discount_amount\": 0,\n \"subtotal_amount\": 23.81,\n \"client_reference\": \"40071075\",\n \"destination_type\": null,\n \"shipping_type_id\": \"NDD\",\n \"order_description\": \"SMART COLOUR EYESHADOW 05\",\n \"original_order_no\": null,\n \"shipping_label_url\": \"https://iqintegrate.com/orders/shipping/generate/IQF-TEST\",\n \"split_order_status\": false,\n \"order_creation_time\": \"2024-10-19 19:22:46\",\n \"shipment_payment_term\": \"DDU\",\n \"total_declared_amount\": 25\n}","options":{"raw":{"language":"json"}}},"url":"CLIENT_WEBHOOK_RECEIVE_ENDPOINT","description":"

Request description:

Attribute	Type	Description
id	Numeric	The unique ID of the order.
awb	String	The Airway Bill number for delivery, if available.
price	decimal	The price of the order.
client_reference	String	The client reference for the order.
order_number	String	The order number.
warehouse	String	The warehouse system code for the order.
order_type	String	The type of order.
comment	String	Additional comments about the order.
order_description	String	Description of the order.
split_order_status	boolean	Indicates if the order is split.
currency	String	The currency of the price.
payment_type	String	The payment type for the order.
order_creation_time	String	The timestamp when the order was created.
shipped_time	String	The timestamp when the order was shipped.
delivered_time	String	The timestamp when the order was delivered.
consignee.name	String	The name of the consignee.
consignee.phone	String	The phone number of the consignee.
consignee.mobile	String	The mobile number of the consignee.
consignee.email	String	The email address of the consignee.
address.address	String	The street address.
address.area	String	The area or locality.
address.province	String	The province or state.
address.town	String	The town or district.
address.city	String	The city.
address.state	String	The state.
address.country	String	The country.
address.zipcode	String	The ZIP code.
address.route	String	The route or street details.
parcel.total_weight	Numeric	Total weight of the parcel.
parcel.total_volume	Numeric	Total volume of the parcel.
parcel.number_of_boxes	Numeric	Number of boxes in the parcel.
current_status.status_id	Numeric	The ID of the status at the specific point in history.
current_status.status	String	The label of the current order status.
current_status.date	String	The timestamp of the current order status.
current_status.comment	String	Comment about the current order status.
skus	Array	An array of SKUs included in the order.
skus.*.line_no	Numeric	The line no of the SKU in the order.
skus.*.alternate_sku_name	String	Alternate name for the SKU.
skus.*.description	String	Name for the SKU.
skus.*.quantity	Numeric	The quantity of the SKU in the order.
skus.*.price	Numeric	The price of the SKU in the order.
skus.*.discounted_price	String	The discounted price of the SKU in the order.
skus.*.serials	Array	An array of serial objects associated with the SKU.
skus..serials..serial_number	String	The serial number of the product.
skus..serials..second_serial_number	String	A second serial number, if available.
skus..serials..scan_time	String	The timestamp when the serial number was scanned.
current_status	Array	Current status data. Only availabel if order status is not split.
current_status.*.status_id	Numeric	The ID of the status at the specific point in history.
current_status.*.status	String	The label of the status at the specific point in history.
current_status.*.date	String	The timestamp when the status change occurred.
current_status.*.comment	String	Comment or details about the status change.
status_history	Array	An array of status history objects.
status_history.*.status_id	Numeric	The ID of the status at the specific point in history.
status_history.*.status	String	The label of the status at the specific point in history.
status_history.*.date	String	The timestamp when the status change occurred.
status_history.*.comment	String	Comment or details about the status change.

","urlObject":{"host":["CLIENT_WEBHOOK_RECEIVE_ENDPOINT"],"query":[],"variable":[]}},"response":[],"_postman_id":"00778eaa-f111-449c-979c-9e5613cb9e64"}],"id":"87312fea-534b-4b0a-90dd-b4b5baecb5fd","_postman_id":"87312fea-534b-4b0a-90dd-b4b5baecb5fd","description":""},{"name":"ASN Status Update","item":[{"name":"Payload of ASN Status Update Webhook","id":"8dc36112-8ead-489f-a0e8-d452da2e23c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 34321,\n \"note\": null,\n \"skus\": [\n {\n \"sku\": \"8059385031125\",\n \"bad_qty\": 0,\n \"line_no\": 92867350,\n \"serials\": [\n {\n \"serial_number\": \"test1\",\n \"second_serial_number\": \"test1\"\n }\n ],\n \"batch_no\": \"42043008\",\n \"good_qty\": 450,\n \"expected_qty\": 450,\n \"received_qty\": 450\n }\n ],\n \"carrier\": null,\n \"asn_type\": \"VPO\",\n \"po_number\": \"9272105182\",\n \"warehouse\": \"IQWH01\",\n \"asn_number\": \"ASNVPO016175\",\n \"created_at\": \"08-10-2024 14:30:19\",\n \"last_status\": \"Closed\",\n \"received_time\": \"15-10-2024 19:50:26\",\n \"invoice_number\": null,\n \"receiving_type\": \"By scanning each\",\n \"status_history\": [\n {\n \"note\": \"\",\n \"time\": 1728383419,\n \"label\": \"Confirmed\",\n \"status_id\": 500,\n \"timestamp\": \"2024-10-08 14:30:19\"\n },\n {\n \"note\": \"\",\n \"time\": 1729007930,\n \"label\": \"Closed\",\n \"status_id\": 550,\n \"timestamp\": \"2024-10-15 19:58:50\"\n }\n ],\n \"asn_reference_1\": \"31766043\",\n \"asn_reference_2\": null,\n \"asn_reference_3\": null,\n \"asn_reference_4\": null,\n \"number_of_boxes\": 1,\n \"return_order_no\": null,\n \"last_status_time\": \"15-10-2024 19:58:50\",\n \"reference_number\": \"31766043\",\n \"return_delivery_no\": null,\n \"expected_arrival_time\": \"17-10-2024 00:00:00\",\n \"supplier_reference_code\": null\n}","options":{"raw":{"language":"json"}}},"url":"CLIENT_WEBHOOK_RECEIVE_ENDPOINT","description":"

Request description:

Attribute	Type	Description
id	integer	Unique ID number of ASN.
warehouse	string	Warehouse systemcode.
asn_number	string	Unique asn number.
asn_type	string	Asn type.
last_status	string	Last status of ASN.
expected_arrival_time	timestamp	Expected arrival time of ASN.
actual_arrival_time	timestamp	Actual arrival time of ASN.
created_at	timestamp	Creation time of ASN.
receiving_type	string	Receiving type of ASN.
carrier	string	Carrier of ASN
reference_number	string	Reference number of ASN.
po_number	string	PO number of ASN.
vehicle_number	string	Vehicle number of ASN.
vehicle_type	string	Vehicle type of ASN.
invoice_number	string	Invoice number of ASN.
number_of_boxes	integer	Number of boxes of ASN.
supplier_reference_code	string	Supplier reference of ASN.
put_on_hold	boolean	Put ASN on hold.
note	string	Note of ASN.
enable_uom_conversion	boolean	enable uom conversion
skus	array	List of SKUs of ASN. Need to enable it by 'include_skus' => true on request body.
skus.*.sku	string	Unique SKU name.
skus.*.bad_qty	integer	Bad quantity of ASN SKU.
skus.*.line_no	integer	Line no of ASN SKU.
skus.*.batch_number	string	Batch number of ASN SKU.
skus.*.good_qty	integer	Good quantity of ASN SKU.
skus.*.expected_qty	integer	Expected quantity of ASN SKU.
skus.*.received_qty	integer	Received quantity of ASN SKU.
skus..serials..serial_number	String	The serial number of the product.
skus..serials..second_serial_number	String	A second serial number, if available.
skus.*.uom	String	UOM
skus.*.uom_quantity	Integer	Quantity of uom
status_history	array	Status history list of ASN. Need to enable it by 'include_status_history' => true on request body.
status_history.*.status_id	integer	Status unique ID number.
status_history.*.label	string	Title of status.
status_history.*.timestamp	timestamp	Status date.
status_history.*.time	numeric	Time in numeric.
status_history.*.note	string	Note of status.

","urlObject":{"host":["CLIENT_WEBHOOK_RECEIVE_ENDPOINT"],"query":[],"variable":[]}},"response":[],"_postman_id":"8dc36112-8ead-489f-a0e8-d452da2e23c5"}],"id":"d3691445-dfff-4fc9-8b3d-619946971ebf","_postman_id":"d3691445-dfff-4fc9-8b3d-619946971ebf","description":""}],"id":"8fc393bb-541d-4bb5-bfd3-841a58f90696","_postman_id":"8fc393bb-541d-4bb5-bfd3-841a58f90696","description":""},{"name":"SKU Categories","item":[{"name":"index","id":"2fa09286-3539-4278-abfb-9091adcc6d3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{IMT_TEST_TOKEN}}","type":"text"},{"key":"Accept-Language","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"page\": 1,\n \"per_page\": 50\n}"},"url":"BASE_URL/api/v3/sku_categories","description":"

Body description:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Example	Type	Validation	Description
page	Shoes	integer	optional	Page number of pagination. Default value: 1
per_page	Red	integer	optional	Items number on per page. Default value: 50

Response description:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
success	boolean	Status of request.
category	object	data.
category.id	integer	Unique ID number of Sku
category.status	boolean	Current status of Category
category.category_type	string	Parent or Sub category
category.name	string	Category name
category.description	string	Category description
category.created_at	string	create time
category.updated_at	string	update time
category.parent_category	object	categoy's parent category if it is Sub

","urlObject":{"path":["api","v3","sku_categories"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"2fa09286-3539-4278-abfb-9091adcc6d3f"},{"name":"Create","id":"075567f0-8d70-4382-9e8b-28caf8fb6e6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{agamyrat_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Shoess\",\n \"description\": \"Shoes\",\n \"parent_category\": \"\",\n \"category_type\": \"Parent\"//Empty value mean category would be created as Parent.\n}"},"url":"BASE_URL/sku_categories/create","description":"

Body description:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Example	Type	Validation	Description
name	Shoes	string	required	It should be unique
description	Red	string	optional	description
parent_category	string	string	reqiured if category type is Sub	Parent category name
category_type	Sub	string	Parent or Sub category

Response description:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
success	boolean	Status of request.
category	object	data.
category.id	integer	Unique ID number of Sku
category.status	boolean	Current status of Category
category.category_type	string	Parent or Sub category
category.name	string	Category name
category.description	string	Category description
category.created_at	string	create time
category.updated_at	string	update time
category.parent_category	object	categoy's parent category if it is Sub

","urlObject":{"path":["sku_categories","create"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"075567f0-8d70-4382-9e8b-28caf8fb6e6f"},{"name":"Update","id":"ca4056d9-6836-407e-a768-99628384661a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{agamyrat_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": 1155,\n \"name\": \"new name\",\n \"description\": \"test description updated\"\n}"},"url":"BASE_URL/sku_categories/update","description":"

Body description:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Example	Type	Validation	Description
id	115	integer	required	unique id of sku category
name	Shoes	string	required	Category name
description	shoes description	string	optional

Response description:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
success	boolean	Status of request.
category	object	data.
category.id	integer	Unique ID number of Sku
category.status	boolean	Current status of Category
category.category_type	string	Parent or Sub category
category.name	string	Category name
category.description	string	Category description
category.created_at	string	create time
category.updated_at	string	update time
category.parent_category	object	categoy's parent category if it is Sub

","urlObject":{"path":["sku_categories","update"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"ca4056d9-6836-407e-a768-99628384661a"}],"id":"461863a6-6671-46d1-983c-3ded377184d3","_postman_id":"461863a6-6671-46d1-983c-3ded377184d3","description":""}]}