Skip to content
Bottle

Download orders as CSV

POST
/orders/export
curl --request POST \
  --url https://example.com/orders/export \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "orderIds": [ "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" ] }'

The orders named, in the order given, as a CSV file: order number, customer, requested date, status, delivery or collection, who delivered it when staff said so, the connected shop it came from, payment, invoice number, total in pounds including VAT, and when it was placed. UTF-8 with a byte order mark and CRLF line ends. Any text cell a spreadsheet would run as a formula has a ' put in front. Orders not found are left out.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
orderIds
required
Array<string>
>= 1 items <= 500 items

Responses

Section titled “Responses”

200

Section titled “200”

The CSV file

Media typetext/csv
string

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed, or a line names something not sold

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example 

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}