API / Variants

Create Variant Endpoint

Structure Variant Name Type Description Required id int The id for the variant No sku string The unique SKU for the variant Yes reference string The unique reference for the variant No name string Display name of the variant No summary string A short summary o...

API / Variants

Update Variant Endpoint

Structure Variant Name Type Description Required sku string The unique SKU for the variant Yes reference string The unique reference for the variant No name string Display name of the variant No summary string A short summary of the variant No description stri...

API / Manufacturers

Manufacturer Index Endpoint

Structure See View Manufacturer Endpoint for the structure of the manufacturer payload inside the  data array. Example Request GET /api/manufacturers?per_page=2 Example Response { "current_page": 1, "data": [ //... ], "first_page_url": "h...

API / Manufacturers

View Manufacturer Endpoint

Structure Manufacturer Name Type Description name string The name of the manufacturer slug string The slug of the manufacturer reference string The reference of the manufacturer logic string The logic of the rules for the manufacturer logo object The logo of t...

API / Manufacturers

Create Manufacturer Endpoint

Structure Manufacturer Name Type Description Required id int The id for the manufacturer No name string The name of the manufacturer Yes slug string The slug of the manufacturer, if not present it is auto-generated from name No reference string The reference o...

API / Manufacturers

Update Manufacturer Endpoint

Structure Manufacturer Name Type Description Required name string The name of the manufacturer No slug string The slug of the manufacturer, if not present it is auto-generated from name No reference string The reference of the manufacturer No logic string The ...

API / Manufacturers

Delete Manufacturer Endpoint

Example Request DELETE /api/manufacturers/{id|name} Example Response 204 No Content

API / Attribute Groups

Attribute Group Index Endpoint

Structure See View Attribute Group Endpoint for the structure of the attribute group payload inside the data array. Example Request GET /api/attribute-groups?per_page=2 Example Response { "current_page": 1, "data": [ //... ], "first_page...

API / Categories

Category Index Endpoint

Structure See View Category Endpoint for the structure of the category payload inside the data array. Example Request GET /api/categories?per_page=2 Example Response { "current_page": 1, "data": [ //... ], "first_page_url": "http://aer...

API / Collections

Collection Index Endpoint

Structure See View Collection Endpoint for the structure of the collection payload inside the data array. Example Request GET /api/collections?per_page=2 Example Response { "current_page": 1, "data": [ //... ], "first_page_url": "http://...

API / Customers

Customer Index Endpoint

Structure See View Customer Endpoint for the structure of the customer payload inside the data array. Filters Name Description Example emails Only return customers with specific emails ?emails=test@gmail.com,example@gmail.com names Only return customers with ...

API / Payment Methods

Payment Method Index Endpoint

Structure See View Payment Method Endpoint for the structure of the payment method payload inside the data array. Example Request GET /api/payment-methods?per_page=2 Example Response { "current_page": 1, "data": [ //... ], "first_page_...

API / Shipping Methods

Shipping Method Index Endpoint

Structure See View Shipping Method Endpoint for the structure of the shipping method payload inside the data array. Example Request GET /api/shipping-methods?per_page=2 Example Response { "current_page": 1, "data": [ //... ], "first_pa...

API / Locations

Location Index Endpoint

Structure See View Location Endpoint for the structure of the location payload inside the data array. Example Request GET /api/locations?per_page=2 Example Response { "current_page": 1, "data": [ //... ], "first_page_url": "http://aero...

API / Flags

Flag Index Endpoint

Structure See View Flag Endpoint for the structure of the flag payload inside the data array. Example Request GET /api/flags?per_page=2 Example Response { "current_page": 1, "data": [ //... ], "first_page_url": "http://aero.test/api/fl...

API / Price Lists

Price List Index Endpoint

Structure See View Price List Endpoint for the structure of the price list payload inside the data array. Example Request GET /api/price-lists?per_page=2 Example Response { "current_page": 1, "data": [ //... ], "first_page_url": "http:...

API / Attribute Groups

View Attribute Group Endpoint

Structure Attribute Group Name Type Description name string The name of the attribute group (e.g., Size or Colour) display_as string The display as of the attribute group (e.g.: dropdown, color_swatches, image_swatches, swatches) reference string The reference...

API / Attribute Groups

Create Attribute Group Endpoint

Structure Attribute Group Name Type Description Required id int The id for the attribute group No name string The name of the attribute group (e.g., Size or Colour) Yes display_as string The display as of the attribute group (e.g.: dropdown, color_swatches, im...