Shipping rules API (v0)

Download OpenAPI specification:Download

Upload a CSV file describing routing rules. This file is usually generated by exporting a Google spreadsheet table, which has the following structure:

Routes				ZIP codes			Location groups			Service levels priority
Country	Destination region	Shipping options	Location group priority	DR1	DR2	...	LG1	LG2	...	SL1
CC1	DR1	...	LG1	111222	3333*	...	001	100	...	SL2
CC1	DR2	...	LG2, LG3, LG4	124*	444*	...	002	111	...	...
...	...	...	...	...	...	...	...	...	...	...

where

CC1, CC2, ... are ISO 3166-1 alpha-2 -- two-letter country codes,
DR1, DR2, ... are customer-defined destination regions,
LG1, LG2, ... are customer-defined location groups,
each ZIP code in a destination region set may use an asterisk (*) which stands for 0 or more arbitrary digits,
each Location group priority field may contain a list of location groups with elements separated by a comma (,),
each location group issued in Location group priority should have a corresponding definition in the Location group column;
Service levels priority block is optional.

See this CSV file for a complete sample.

Upload routing rules as a CSV file

Upload a CSV file describing routing rules.

Authorizations:

newStoreAccessToken

Request Body schema: multipart/form-data

string <binary>

Responses

Response samples

Content type

application/json

Example

Cannot parse Content-Length HTTP header.

{"error_code": "invalid_http_header",
"message": "Cannot parse Content-Length HTTP header.",
"request_id": "3233d29d-9553-4133-8f1b-8622415f42ba"
}