Skip to navigation

Create

Creates a pricing zone from stores, postal codes or a map area for zone rate-sheet rules. | authz: allowed_org_types=[provider], min_org_role=operator | (PricingZoneClientCreate1) -> (PricingZone1)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringRequiredformat: "\S"1-255 characters
schema_versionintegerRequired
map_areaobject or nullOptional
postal_code_country_codestring or nullOptionalformat: "^[A-Z]{2}$"
postal_codeslist of stringsOptional
shipper_account_idslist of stringsOptional

Response

Successful Response
_idstring
created_at_timestampstringformat: "date-time"
created_by_user_idstring

Must be a string starting with user_

last_edited_at_timestampstringformat: "date-time"
last_edited_by_user_idstring

Must be a string starting with user_

namestringformat: "\S"1-255 characters
owned_by_org_idstring

Must be a string starting with org_

schema_versioninteger
archived_at_timestampstring or nullOptionalformat: "date-time"
archived_by_user_idstring or nullOptional
map_areaobject or nullOptional
postal_code_country_codestring or nullOptionalformat: "^[A-Z]{2}$"
postal_codeslist of stringsOptional
shipper_account_idslist of stringsOptional

Errors

422
Unprocessable Entity Error