Routing ruleset API (v0)

Download OpenAPI specification:Download

Define routing rules for your business

Get routing rules example

Retrieves the current 'fulfillment configuration V1' transformed to adhere to the 'Routing Rule' V2 format. It shows the change in value-mapping between V1 and V2. If already using V2, this endpoint is of no use, and will return the current configuration. Refer to the 'Response Examples' to see the type of structure to be returned.

Authorizations:

newStoreAccessToken

Responses

Response samples

200
404
500

Content type

application/json

{"routes": [{"fulfilled_by": {"2_DAY": ["2_DAY::aa3093554472fd113135bed5b63e12f84c2e9fe8::df58248c414f342c81e056b40bee12d17a08bf61"
],
"GROUND": ["GROUND::aa3093554472fd113135bed5b63e12f84c2e9fe8::df58248c414f342c81e056b40bee12d17a08bf61"
]
},
"destination_region": {"country": "US",
"zip_code_region": "aa3093554472fd113135bed5b63e12f84c2e9fe8::df58248c414f342c81e056b40bee12d17a08bf61"
}
}
],
"sl_levels_priority": ["GROUND",
"2_DAY"
],
"location_groups": {"2_DAY::aa3093554472fd113135bed5b63e12f84c2e9fe8::df58248c414f342c81e056b40bee12d17a08bf61": ["DC01",
"US15",
"US16"
],
"GROUND::aa3093554472fd113135bed5b63e12f84c2e9fe8::df58248c414f342c81e056b40bee12d17a08bf61": ["US01",
"US02",
"US03"
]
},
"zip_code_regions": {"aa3093554472fd113135bed5b63e12f84c2e9fe8::df58248c414f342c81e056b40bee12d17a08bf61": ["*"
]
}
}

Get routing rules

Retrieves the current 'Routing Rule V2'. If customer using V1, this endpoint is of no use, and will return the error.

Authorizations:

newStoreAccessToken

Responses

Response samples

200
404
500

Content type

application/json

{"routes": [{"fulfilled_by": {"2_DAY": ["2_DAY::WEST"
],
"GROUND": ["GROUND::WEST"
]
},
"destination_region": {"country": "US",
"zip_code_region": "WEST"
}
}
],
"sl_levels_priority": ["GROUND",
"2_DAY"
],
"location_groups": {"2_DAY::WEST": ["DC01",
"US15",
"US16"
],
"GROUND::WEST": ["US01",
"US02",
"US03"
]
},
"zip_code_regions": {"WEST": ["*"
]
}
}

Updates the routing rules

This endpoint is used to initially seed the routing rules or to replace it completely

Authorizations:

newStoreAccessToken

Request Body schema: application/json

	Array of objects Routing rules specification
sl_levels_priority	Array of strings non-empty [ items non-empty ] Service levels priority. This is ordered according to which service level will be taken first
	object Location groups identifiers
	object Zip code groups, in order to facilitate the identification routes per regions

Responses

Request samples

Payload

Content type

application/json

{"routes": [{"fulfilled_by": {"2_DAY": ["2_DAY::WEST"
],
"GROUND": ["GROUND::WEST"
]
},
"destination_region": {"country": "US",
"zip_code_region": "WEST"
}
}
],
"sl_levels_priority": ["GROUND",
"2_DAY"
],
"location_groups": {"2_DAY::WEST": ["DC01",
"US15",
"US16"
],
"GROUND::WEST": ["US01",
"US02",
"US03"
]
},
"zip_code_regions": {"WEST": ["*"
]
}
}

Response samples

201
400
500

Content type

application/json

{"routing_ruleset": {"routes": [{"fulfilled_by": {"2_DAY_PR": ["NJ"
]
},
"destination_region": {"country": "PR",
"zip_code_region": "All"
}
}
],
"sl_levels_priority": ["2_DAY_PR"
],
"location_groups": {"NJ": ["US_NJ"
]
},
"zip_code_regions": {"All": ["*"
]
}
},
"fulfillment_config_uri": "v0/fulfillment_configuration/revision/13"
}

Patch the routing rules

A convenience endpoint, where you can use json patch to change parts of the currently enabled routing rules if the v2 fulfillment config is used. Mostly used by the UI.

Authorizations:

newStoreAccessToken

Request Body schema: application/json

Array

One of

path required	string A JSON Pointer path.
op required	string Enum: "add" "replace" "test" The operation to perform.
value required	any The value to add, replace or test.

Responses

Request samples

Payload

Content type

application/json

[{"op": "add",
"path": "/location_groups/2_DAY::WEST/-",
"value": "US10"
}
]

Response samples

200
400
500

Content type

application/json

{"routing_ruleset": {"routes": [{"fulfilled_by": {"2_DAY_PR": ["NJ"
]
},
"destination_region": {"country": "PR",
"zip_code_region": "All"
}
}
],
"sl_levels_priority": ["2_DAY_PR"
],
"location_groups": {"NJ": ["US_NJ"
]
},
"zip_code_regions": {"All": ["*"
]
}
},
"fulfillment_config_uri": "v0/fulfillment_configuration/revision/13"
}

Get routing rules section

Retrieves a section of the current 'Routing Rule V2'. If customer using V1, this endpoint is of no use, and will return the error.

Authorizations:

newStoreAccessToken

path Parameters

section

required

string

Enum: "routes" "sl_levels_priority" "location_groups" "zip_code_regions"

name of the section to retrieve

Responses

Response samples

200
400
500

Content type

application/json

{"zip_code_regions": {"West": ["90210",
"90211",
"90212",
"90213"
],
"East": ["10001",
"10002",
"10003",
"10004",
"10005"
],
"South": ["33101",
"33102",
"33103",
"33104",
"33105",
"33106"
]
}
}