Orders
Options like product_id, location_id, and more can be retrieved using the Products endpoint.
Get Orders
GET
/orders
Query Parameters
Name | Type | Description | Available options |
---|---|---|---|
product_id | Integer | Product id | |
page | Integer | Number of page | |
per_page | Integer | Number of orders to get per page | |
location_id | Integer | Location id | |
status | String | Order status | |
note_search | String | Phrases in order's note field to search by | |
order_ids | Array | Order ids to get |
Example response:
Get Order
GET
/orders/{order_id}
Example response:
Calculate Pricing
GET
/orders/calculate-pricing
Query Parameters
Name | Type | Description |
---|---|---|
product_id | Integer | Product id |
product_plan_id | Integer | Product plan id |
product_location_id | Integer | Product location id |
quantity | Integer | Proxy quantity |
coupon_code | String | Coupon code |
Example response:
Create Order
POST
/orders
Body Parameters
Name | Type | Description |
---|---|---|
product_id | Integer | Product id |
product_plan_id | Integer | Product plan id |
product_location_id | Integer | Product location id |
quantity | Integer | Proxy quantity |
coupon_code | String | Coupon code |
auto_extend | Boolean | Should the order be extended automatically |
product_question_answers | Array | Answers to questions |
Example response:
Extend Order
POST
/orders/{order_id}/extend
Body Parameters
Name | Type | Description |
---|---|---|
product_plan_id | Integer | Product plan id |
Example response:
Last updated