Orders

All Orders

GET https://yoursite.mavenseed.com/api/v1/orders

Retrieve all orders

Path Parameters

Name	Type	Description
page	integer	Results are paginated.

Headers

Name	Type	Description
Authorization	string	Auth token

200 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": "[email protected]",
        "currency": "USD",
        "created_at": "2019-03-12T23:42:02.341-04:00",
        "updated_at": "2019-03-12T23:42:02.341-04:00"
    }
]

Show Order

GET https://yoursite.mavenseed.com/api/v1/orders/:id

Retrieve a single order

Headers

Name	Type	Description
Authorization	string	Auth token

200

{
    "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

null

Create Order

POST https://yoursite.mavenseed.com/api/v1/orders

Create an order.

Headers

Name	Type	Description
Authorization	string	Auth Token

Request Body

Name	Type	Description
customer_id	integer	ID of customer for order
guest_email	string	email of guest user
currency	string	Default is USD

201

{
    "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",
}

Update Order

PATCH https://yoursite.mavenseed.com/api/v1/orders/:id

Update a single order. All of the above properties in create order are valid.

Headers

Name	Type	Description
Authorization	string	Auth token

200

{
    "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 a Order

DELETE https://yoursite.mavenseed.com/api/v1/orders/:id

Delete an order.

Headers

Name	Type	Description
Authorization	string	Auth toke

200