Check ZIP

Staging

https://apis.hellotech.com

POST

/api/partners/skus/{id}/check_zip

Checks availability of a SKU based on a SKU. If treatment is on then SKU is available, otherwise SKU is not available in the area.

Request

Authorization

Add parameter in header

Api-Key

Example:

Api-Key: ********************

Path Params

Header Params

Body Params application/json

Example

{
    "zip": "12345"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://apis.hellotech.com/api/partners/skus//check_zip' \
--header 'Accept-Encoding: application/json' \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "zip": "12345"
}'

Responses

🟢200OK

application/json

Body

Example

{
    "status": "string",
    "treatment": "on",
    "zip": "string",
    "cbsa_id": 0,
    "cbsa": "string"
}

🟠404Record Not Found

Modified at 2026-02-23 11:51:21

Retrieve all SKUs

ErrorResponse