API / Tags

Create Tag Endpoint

Structure Tag Name Type Description Required id int The id for the tag No name string The name of the tag Yes slug string The slug of the tag, if not present it is auto-generated from name Conditional reference string The reference of the tag No image object T...

API / Tags

Update Tag Endpoint

Structure Tag Name Type Description Required name string The name of the tag No slug string The slug of the tag No reference string The reference of the tag No image object The Image of the tag No has_slug boolean Whether the tag has a slug or not No Image Nam...

API / Tags

Delete Tag Endpoint

Example Request DELETE /api/tag-groups/{id|name}/tags/{id|name} Example Response 204 No Content

API / Customers

View Customer Endpoint

Structure Customer Name Type Description id int The id of the customer name string The name of the customer email string The email of the customer created_at timestamp The date that the customer was created at group object The group the customer belongs to, se...

API / Customers

Create Customer Endpoint

Structure Customer Name Type Description Required id int The id for the customer No name string The name of the customer Yes email string The email of the customer Yes password string The plain-text password of the customer Conditional  * password_hash string ...

API / Customers

Update Customer Endpoint

Structure Customer Name Type Description Required id int The id for the customer No name string The name of the customer No email string The email of the customer No group string The group name of the customer No tax_group string The tax group name of the cust...

API / Addresses

Create Address Endpoint

Structure Name Type Description Required id int The id for the address No name string The name of the address No first_name string The first name for the address Yes last_name string The last name for the address Yes company string The company for the address ...

API / Addresses

Update Address Endpoint

Structure Name Type Description Required id int The id for the address No name string The name of the address No first_name string The first name for the address No last_name string The last name for the address No company string The company for the address No...

API / Addresses

Delete Address Endpoint

Example Request DELETE /api/customers/{id}/addresses/{id} Example Response 204 No Content

API / Payment Methods

View Payment Method Endpoint

Structure Name Type Description id int The id of the payment method name string The name of the payment method driver string The driver for the payment method available boolean Whether the payment method is available for use Example Request GET /api/payment-me...

API / Shipping Methods

View Shipping Method Endpoint

Structure Shipping Method Name Type Description id int The id of the shipping method name string The name of the shipping method available boolean Whether the shipping method is available for use rates array An array of Rate objects Rate Name Type Description ...

API / Locations

View Location Endpoint

Structure Location Name Type Description id int The id for the location name string The name of the location email string The email of the location phone string The phone number for the location line_1 string The first line for the location line_2 string The s...

API / Locations

Create Location Endpoint

Structure Location Name Type Description Required id int The id for the location No name string The name of the location Yes email string The email of the location No phone string The phone number for the location No line_1 string The first line for the locati...

API / Locations

Update Location Endpoint

Structure Location Name Type Description Required id int The id for the location No name string The name of the location No email string The email of the location No phone string The phone number for the location No line_1 string The first line for the locatio...

API / Flags

View Flag Endpoint

Structure Name Type Description id int The id of the flag name string The unique name for the flag color hexcode The colour of the flag (format ##RRGGBB) created_at timestamp The date the flag was created Example Request GET /api/flags/{id|name} Example Respon...

API / Flags

Create Flag Endpoint

Structure Name Type Description Required id int The id for the flag No name string The name of the flag Yes color hexcode The color of the flag (format ##RRGGBB) Yes Example Request POST /api/flags/ { "name": "API Flag", "color": "#000000", } Example R...

API / Flags

Update Flag Endpoint

Structure Name Type Description Required name string The name of the flag No color hexcode The color of the flag (format ##RRGGBB) No Example Request PUT /api/flags/{id|name} { "name": "API Flag Updated", "color": "#A1B2C3", } Example Response { "f...

API / Flags

Delete Flag Endpoint

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