CatalogAPI
Catalog API is a service that ties your application to our catalog and order support department. With minimal integration, you can receive data feeds easily scoped to your demographics to provide exciting, up-to-date, and motivating catalogs. Your pa
CatalogAPI endpoints
| Method | Endpoint | Description |
|---|---|---|
| Carts | ||
| GET |
Place Order /{format}/cart_order_place |
This method places as order using the address and items in the cart. Once the order is placed, the cart is deleted. |
| GET |
Remove Item /{format}/cart_remove_item |
Removes items from the cart. |
| GET |
Empty /{format}/cart_empty |
Removes all items in the cart. |
| GET |
Unlock /{format}/carts_unlock |
Unlocks a cart that has been locked via the cart_validate method. |
| GET |
View /{format}/cart_view |
Returns the current address and items in the cart. |
| GET |
Validate /{format}/cart_validate |
Validates the address and items in the cart. You should call this method just before placing an order to make sure that the order will not be rejected. |
| GET |
Set Address /{format}/cart_set_address |
Adds a shipping address to the cart |
| GET |
Set Item Quantity /{format}/cart_set_item_quantity |
Adds items to the cart. The quantity passed to this call overrides the quantity of a duplicate item. |
| GET |
Add Item /{format}/cart_add_item |
Adds items to the cart |
| Other endpoints | ||
| GET |
Search Catalog /{format}/search_catalog |
Searches the catalog based on the parameters passed. |
| POST |
Place Order without Cart //order_place |
The order place method has a different endpoint than the other methods. You must POST your request to /v1/json/order_place/ if you are sending the order as json, or to… |
| GET |
Catalog Breakdown /{format}/catalog_breakdown |
Breaks down the catalog into its categories |
| GET |
List Available Catalogs /{format}/list_available_catalogs |
Lists the Available Catalogs |
| GET |
Order List /{format}/order_list |
This method returns a list of order numbers (the Catalog API order numbers, not external_order_number) that match a given external_user_id. |
| GET |
View Item /{format}/view_item |
Returns an image and description of the item |
| GET |
Track Order /{format}/order_track |
Tracks an order given an order number. |
CatalogAPI pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|