API / Price Lists

View Price List Endpoint

Structure Price List Name Type Description id int The id of the price list name string The name of the price list applies_to string The applies to of the price list (e.g., everyone, not-customers, customers, groups) start_at timestamp The start at of the price...

API / Price Lists

Create Price List

Structure Price List Name Type Description Required id int The id of the price list No name string The name of the price list Yes applies_to string The applies to of the price list (everyone, not-customers, customers, groups) Yes start_at timestamp The start a...

API / Price Lists

Update Price List

Structure Price List Name Type Description Required name string The name of the price list No applies_to string The applies to of the price list (everyone, not-customers, customers, groups) No start_at timestamp The start at of the price list No end_at timesta...

API / Price List Entries

Create Price List Entry Endpoint

Structure Price List Entry Name Type Description Required id int The id for the entry No for string What the entry applies to (e.g., all_products, all_products_unless_reduced, product, variant, category, tag, manufacturer) Yes target string Identifier of the t...

API / Price List Entries

Update Price List Entry Endpoint

Structure Price List Entry Name Type Description Required id int The id for the entry No for string What the entry applies to (e.g., all_products, all_products_unless_reduced, product, variant, category, tag, manufacturer) No target string Identifier of the ta...

API / Specification Groups

Specification Group Index Endpoint

This endpoint is only available if aerocargo/specifications is installed. Structure See View Specification Group for the structure of the specification group payloads inside the  data array. Example Request GET /api/specification-groups?per_page=2 Example Res...

API / Specification Groups

View Specification Group Endpoint

This endpoint is only available if aerocargo/specifications is installed. Structure Specification Group Name Type Description Version id int The id of the specification group >=0.1.0 name string The name for the specification group >=0.1.0 sort int The sort f...

API / Specification Groups

Create Specification Group Endpoint

This endpoint is only available if aerocargo/specifications is installed. Structure Specification Group Name Type Description Required Version id int The id of the specification group No >=0.1.0 name string The name for the specification group Yes >=0.1.0 sor...

API / Specification Groups

Update Specification Group Endpoint

This endpoint is only available if aerocargo/specifications is installed. Structure Specification Group Name Type Description Required Version id int The id of the specification group No >=0.1.0 name string The name for the specification group No >=0.1.0 sort...

API / Upsell Groups

Upsell Group Index Endpoint

This endpoint is only available if aerocargo/upsells is installed. Structure See View Upsell Group Endpoint for the structure of the upsell group payload inside the data array. Example Request GET /api/upsell-groups?per_page=2 Example Response { "current...

API / Upsell Groups

View Upsell Group Endpoint

This endpoint is only available if  aerocargo/upsells is installed. Structure Name Type Description key string The key of the upsell group name string The name for the upsell group Example Request GET /api/upsell-groups/{key} Example Response { "key": "api...

API / Upsell Groups

Create Upsell Group Endpoint

This endpoint is only available if  aerocargo/upsells is installed. Structure Name Type Description Required key int The key of the upsell group Yes name string The name for the upsell group Yes Example Request POST /api/upsell-groups/ { "key": "api-test",...

API / Upsell Groups

Update Upsell Group Endpoint

This endpoint is only available if  aerocargo/upsells is installed. Structure Name Type Description Required key int The key of the upsell group No name string The name for the upsell group No Example Request PUT /api/upsell-groups/{key} { "name": "API Tes...

API / Listing Collection Groups

Listing Collection Group Index

This endpoint is only available if  aerocargo/listing-collections is installed. Structure See View Listing Collection Group Endpoint for the structure of the listing collection group payload inside the data array. Example Request GET /api/listing-collection-gr...

API / Listing Collection Groups

View Listing Collection Group Endpoint

This endpoint is only available if  aerocargo/listing-collections is installed. Structure Listing Collection Group Name Type Description key string The key of the listing collection group name string The name for the listing collection group listings array An ...

API / Listing Collection Groups

Create Listing Collection Group Endpoint

This endpoint is only available if  aerocargo/listing-collections is installed. Structure Listing Collection Group Name Type Description Required key string The key of the listing collection group Yes name string The name for the listing collection group Yes l...

API / Listing Collection Groups

Update Listing Collection Group Endpoint

This endpoint is only available if  aerocargo/listing-collections is installed. Structure Listing Collection Group Name Type Description Required key string The key of the listing collection group No name string The name for the listing collection group No lis...

API / Stock

Update Stock Endpoint

Structure Name Type Description *.sku string The SKU of the variant Yes *.stock_level int The new stock_level of the variant Yes *.stock_action string The stock action (e.g., set, add, remove & multiply). Defaults to set No Example Request POST /api/stock Exam...