Service levels API (v0)

Download OpenAPI specification:Download

Represents service levels for routing configuration at NewStore.

Important: This endpoint should be used once you have initialized the new version of the configuration through the Routing Ruleset API.

List service levels

Retrieves all the service levels configurations for your business.

Authorizations:

newStoreAccessToken

Responses

Response samples

200
404
500

Content type

application/json

{"2_DAY": {"currency_code": "USD",
"delivery_time": "2-3 business days",
"delivery_time_after_cutoff_hour": "",
"display_name": "Standard",
"price": 22,
"remorse_period": 30,
"tax_code": ""
},
"GROUND": {"currency_code": "USD",
"delivery_time": "3-7 business days",
"delivery_time_after_cutoff_hour": "",
"display_name": "Ground - 5 minute remorse period",
"price": 5,
"remorse_period": 350,
"tax_code": ""
}
}

Set service levels

Updates all the service levels configurations for your business.

Authorizations:

newStoreAccessToken

Request Body schema: application/json

.*

pattern property

any

Responses

Request samples

Payload

Content type

application/json

{"2_DAY": {"currency_code": "USD",
"delivery_time": "2-3 business days",
"delivery_time_after_cutoff_hour": "",
"display_name": "Standard",
"price": 22,
"remorse_period": 30,
"tax_code": ""
},
"GROUND": {"currency_code": "USD",
"delivery_time": "3-7 business days",
"delivery_time_after_cutoff_hour": "",
"display_name": "Ground - 5 minute remorse period",
"price": 5,
"remorse_period": 350,
"tax_code": ""
}
}

Response samples

200
400
500

Content type

application/json

{"fulfillment_config_uri": "fulfillment_config/revisions/1",
"service_levels": {"2_DAY": {"currency_code": "USD",
"delivery_time": "2-3 business days",
"delivery_time_after_cutoff_hour": "",
"display_name": "Standard",
"price": 22,
"remorse_period": 30,
"tax_code": ""
},
"GROUND": {"currency_code": "USD",
"delivery_time": "3-7 business days",
"delivery_time_after_cutoff_hour": "",
"display_name": "Ground - 5 minute remorse period",
"price": 5,
"remorse_period": 350,
"tax_code": ""
}
}
}

Patch service levels

Patch list of shipping levels configurations for your business with the given JSONPatch.

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": "remove",
"path": "/2_DAY"
},
{"op": "replace",
"path": "/GROUND/price",
"value": 10
}
]

Response samples

200
400
404
500

Content type

application/json

{"fulfillment_config_uri": "fulfillment_config/revisions/1",
"service_levels": {"2_DAY": {"currency_code": "USD",
"delivery_time": "2-3 business days",
"delivery_time_after_cutoff_hour": "",
"display_name": "Standard",
"price": 22,
"remorse_period": 30,
"tax_code": ""
},
"GROUND": {"currency_code": "USD",
"delivery_time": "3-7 business days",
"delivery_time_after_cutoff_hour": "",
"display_name": "Ground - 5 minute remorse period",
"price": 5,
"remorse_period": 350,
"tax_code": ""
}
}
}

Get service level

Retrieves the service level by its identifier.

Authorizations:

newStoreAccessToken

path Parameters

id

required

string

The ID of the service level. To retrieve the ID, use the List service levels method.

Responses

Response samples

200
404
500

Content type

application/json

{"2_DAY": {"currency_code": "USD",
"delivery_time": "2-3 business days",
"delivery_time_after_cutoff_hour": "",
"display_name": "Standard",
"price": 22,
"remorse_period": 30,
"tax_code": ""
}
}