Search zone tax codes

POST 
/v2/zone-tax-codes/search

Search zone tax codes

Request

application/json

Body

Search zone tax codes

pageintegernullable
Pagination page number
Possible values: >= 1
Default value: 1
Example: 1
offsetintegernullable
Pagination offset number
Possible values: >= 1
Default value: 12
Example: 12

createdAt

object

greaterThandate-time

Date greater than provided date

Example: 2314-03-14T03:14:15.926Z

lessThandate-time

Date less than provided date

Example: 2314-03-14T03:14:15.926Z

lastModifiedAt

object

greaterThandate-time

Date greater than provided date

Example: 2314-03-14T03:14:15.926Z

lessThandate-time

Date less than provided date

Example: 2314-03-14T03:14:15.926Z
idsstring[]
List of Zone tax codes primary identifiers
Example: ["018fcdb1-52d3-7c32-bf7c-46d49b338bca","018fcdb1-52d3-72c4-85dc-4ade9c4de935","018fcdb1-52d3-74b6-86d6-5e705b84c1e2"]
priceIdsstring[]
List of Price primary identifiers
Example: ["018fcdb1-52d3-7c32-bf7c-46d49b338bca","018fcdb1-52d3-72c4-85dc-4ade9c4de935","018fcdb1-52d3-74b6-86d6-5e705b84c1e2"]
taxCodesnumber[]nullable
Discount type
Possible values: [[object Object]]
Example: ["H"]
zonesstring[]
Search by zone code
Example: ["US","NL"]
sortInputsstring[]

Inputs to sort by

Responses

200

Paginated list of zone tax codes

application/json

Schema

Schema

items

object[]

required

List of items of type ZoneTaxCode

Array [

iduuidrequired

Primary identifier

Possible values: <= 36 characters

Example: 8bcacf9d-36a2-48d5-b713-eedb4eb8c28b

priceIduuidrequired

Price foreign identifier

Possible values: <= 36 characters

Example: 01905943-4866-7626-b54b-76ea11b2c507

createdAtdate-timerequired

Creation date

Example: 2022-01-01T00:00:00.000Z

lastModifiedAtdate-timerequired

Last modified date

Example: 2022-01-02T00:00:00.000Z

zonestringrequired

Zone code

Possible values: <= 5 characters

Example: US

taxCodestringnullablerequired

Tax code

Possible values: [H, L, N]

Example: H

]

itemsFoundintegerrequired
Total number of items found
Example: 12
offsetintegernullablerequired
The amount of items to show per page
Possible values: >= 1
Default value: 12
Example: 12
pageintegernullablerequired
The current page
Possible values: >= 1
Default value: 1
Example: 4
pagesintegernullablerequired
Total amount of pages
Possible values: >= 1
Example: 1
startintegernullablerequired
Start position of the current page
Possible values: >= 1
Example: 1
endintegernullablerequired
End position of the current page
Possible values: >= 1
Example: 12

Example (from schema)

{
  "items": [
    {
      "id": "8bcacf9d-36a2-48d5-b713-eedb4eb8c28b",
      "priceId": "01905943-4866-7626-b54b-76ea11b2c507",
      "createdAt": "2022-01-01T00:00:00.000Z",
      "lastModifiedAt": "2022-01-02T00:00:00.000Z",
      "zone": "US",
      "taxCode": "H"
    }
  ],
  "itemsFound": 12,
  "offset": 12,
  "page": 4,
  "pages": 1,
  "start": 1,
  "end": 12
}

400

Bad request

403

Forbidden.

500

Unknown get zone tax codes error