Orders API

The Orders API for FaxStore handles the creation, updating, deletion, and retrieval of orders. It ensures efficient order management throughout the purchasing process.

The Orders API is deprecated. To fetch an accounts orders it is recommended to use the Accounts API.
To fetch all orders made on the store refer to the Payments API.

Table of Contents

Get Accounts Orders

GET/api/orders/account/:id

Returns all orders placed by the specified account.

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	String	required	The user ID to fetch orders from.

Responses

200OKjson

View response body

[
  {
    "id": 74,
    "userId": "282762192544333827",
    "username": "John Doe",
    "object": "{"title":"Cart payment via PayPal","payment":{"subtotal":"9.99","discount":"0.00","total":"9.99","promoCode":null},"items":[{"name":"Skins  - 2","price":"9.99","description":"Item type: 1"}],"createdAt":1699931646679}",
    "createdAt": "1699931646679",
    "method": "via PayPal",
    "customer": "{"id":"1DC02600C4769332G","email":"sb-h2sue18503054@personal.example.com","name":"John Doe"}",
    "ip": "::1"
  },
  ...
]

Examples

curl -X GET 'https://api.example.com/api/orders/account/123' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.example.com/api/orders/account/123', {
  "method": "GET",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN"
  }
})
const data = await response.json()

import requests

response = requests.get('https://api.example.com/api/orders/account/123', headers={
    "Authorization": "Bearer YOUR_API_TOKEN"
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'GET',
    'header' => "Authorization: Bearer YOUR_API_TOKEN"
  ]
]);

$response = file_get_contents('https://api.example.com/api/orders/account/123', false, $context);
$data = json_decode($response, true);

Document History

Loading version history...