Orders

get
All Orders

https://yoursite.mavenseed.com/api/v1/orders
Retrieve all orders
Request
Response
Path Parameters
page
optional
integer
Results are paginated.
Headers
Authorization
required
string
Auth token
200: OK
Returns an array of members. Only the first 20 are returned. Passing the page param will paginate the results.
[
{
"id": 4,
"customer_id": 3,
"guest_email": null,
"currency": "USD",
"created_at": "2019-02-22T11:43:44.193-05:00",
"updated_at": "2019-02-22T11:43:44.193-05:00"
},
{
"id": 11,
"customer_id": 12,
"guest_email": "chapt0r+test02@gmail.com",
"currency": "USD",
"created_at": "2019-03-12T23:42:02.341-04:00",
"updated_at": "2019-03-12T23:42:02.341-04:00"
}
]

get
Show Order

https://yoursite.mavenseed.com/api/v1/orders/:id
Retrieve a single order
Request
Response
Headers
Authorization
required
string
Auth token
200: OK
{
"id": 4,
"customer_id": 3,
"guest_email": null,
"currency": "USD",
"created_at": "2019-02-22T11:43:44.193-05:00",
"updated_at": "2019-02-22T11:43:44.193-05:00",
}
404: Not Found
null

post
Create Order

https://yoursite.mavenseed.com/v1/orders
Create an order.
Request
Response
Headers
Authorization
required
string
Auth Token
Form Data Parameters
customer_id
required
integer
ID of customer for order
guest_email
optional
string
email of guest user
currency
required
string
Default is USD
200: OK
{
"id": 4,
"customer_id": 3,
"guest_email": null,
"currency": "USD",
"created_at": "2019-02-22T11:43:44.193-05:00",
"updated_at": "2019-02-22T11:43:44.193-05:00",
}

patch
Update Order

https://yoursite.mavenseed.com/v1/orders/:id
Update a single order. All of the above properties in create order are valid.
Request
Response
Headers
Authorization
optional
string
Auth token
200: OK
{
"id": 4,
"customer_id": 3,
"guest_email": null,
"currency": "USD",
"created_at": "2019-02-22T11:43:44.193-05:00",
"updated_at": "2019-02-22T11:43:44.193-05:00"
}

delete
Delete a Order

https://yoursite.mavenseed.com/v1/orders/:id
Delete an order.
Request
Response
Headers
Authorization
required
string
Auth toke
200: OK
‚Äč