What conventions does the API use?

Attribute Conventions

• Keys generally match the attribute name on their respective models.
• Exception: Attributes ending in "_code" should omit the suffix when passed to the API, e.g. currency_code => currency

Relationship Conventions

• Nested data should use a snake_case version of the relationship method name where present, e.g.: shippingMethod => shipping_method

Price Conventions

• Prices retrieved from the API are mostly in the currency's smallest unit, e.g. 1000 = 10 GBP
• Prices should generally be provided in the currency’s standard unit, e.g. 10 = 10 GBP (unless otherwise stated)
• Prices should generally be passed as an object, e.g.:
  
  

  {
      "price": {
          "amount": 400, // Excluding tax
          "tax": 80
      }
  }

  Exception: Some endpoints support passing a single tax-inclusive value:
  
  

  {
      "price": 480 // Including tax
  }

  See the relevant endpoint docs to see if this is supported for an endpoint

Date Conventions

• Dates must be Carbon-parseable, supported formats include:
  • 2023-09-01T09:29:41.000000Z
  • 2023-09-01 09:29:41
  • 2023-09-01 (defaults to midnight if no time is provided)

Pagination Conventions

The min_updated_at and max_updated_at parameters are only supported by index endpoints.

Responses follow Laravel's pagination format, e.g.:

{
    "current_page": 1,
    "data": [
        //...
    ],
    "first_page_url": "http://aero.test/api/products?page=1",
    "from": 1,
    "last_page": 2,
    "last_page_url": "http://aero.test/api/products?page=2",
    "next_page_url": "http://aero.test/api/products?page=2",
    "path": "http://aero.test/api/products",
    "per_page": 24,
    "prev_page_url": null,
    "to": 24,
    "total": 29
}

Scope Conventions

• Index endpoints support a scope parameter, which is a comma-separated list of scopes.
• Supported scopes are endpoint-specific and documented in endpoint-specific example docs.

Image Factory Conventions

If any of these query parameters are present in the GET requests, Image Factory will be applied.