Orchid Estate API Documentation
Endpoint
`POST` https://estateapi.orchid-apps.com/api/submit_upc
This API endpoint allows you to submit a Universal Product Code (UPC) along with a ZIP code to retrieve information about the product's availability in the specified location.
The request should be made using the `POST` method. The request body should be sent as raw JSON.
|
Parameter |
Type |
Description |
|
api_key |
string |
API key provided by Orchid during implementation |
|
zip_code |
string |
ZIP code representing the desired location |
|
upc |
string |
Universal Product Code (UPC) of the product |
POST h(ps://estateapi.orchid-apps.com/api/submit_upc
Content-Type: application/json
{
"api_key": "aaaacccc-bbbb-9999-dddd-19d9bf4b94cb",
"zip_code": "21205",
"upc": "090161045156"
}
The API response will provide information about the product's availability based on the submitted UPC and ZIP code.
|
Response |
Description |
|
1 |
Unrestricted |
|
2 |
Restricted |
|
3 |
Roster State |
|
5 |
UPC not found |
You can use the following test ZIP code and test UPCs to simulate different responses:
Test ZIP Code: 21205
Test UPCs:
- UPC: 090161045156, Response: 1 (Unrestricted)
- UPC: 845737002367, Response: 2 (Restricted)
- UPC: 022188865813, Response: 3 (Roster State)
- UPC: 123412341234, Response: 5 (UPC not found)
Please note that the actual availability of products may vary based on real-Ime data.