Skip to main content

SCAYLE

Use SCAYLE to manage your commerce catalog and operations through the Admin API. With these operations you can list, create, update, and delete products, variants, prices, stocks, categories, brands, orders, customers, vouchers, promotions, and more from your Boltic workflows.

Prerequisites​

To use SCAYLE, you need:

  • A SCAYLE tenant with Admin API access.
  • An Admin API token generated in the SCAYLE Panel (Settings > General > API Keys > Admin API Keys).

For the full API reference, visit the official SCAYLE Admin API Documentation.

Supported Authentication Methods​

  • Access Token sent as the X-Access-Token header.

Basic Operations​

Product​

  • List Products: Retrieve a paginated list of products.
  • Get a Product: Retrieve a single product by its ID.
  • Create a Product: Create a new product.
  • Update a Product: Update an existing product.
  • Delete a Product: Delete a product by its ID.

Product Variant​

  • List Product Variants: Retrieve the variants of a product.
  • Get a Product Variant: Retrieve a single variant by its ID.
  • Create a Product Variant: Create a new variant.
  • Update a Product Variant: Update an existing variant.
  • Delete a Product Variant: Delete a variant by its ID.

Price​

  • List Prices: Retrieve the prices of a variant.
  • Create a Price: Create a price for a variant.
  • Delete a Price: Delete a price by its ID.

Stock​

  • List Stock: Retrieve the stock of a variant.
  • Create Stock: Set the stock for a variant.

Product Image​

  • List Product Images: Retrieve the images of a product.
  • Create a Product Image: Add an image to a product.
  • Update Image Position: Update the position of a product image.
  • Delete a Product Image: Delete a product image by its ID.

Category​

  • List Categories: Retrieve the categories of a shop.
  • Get a Category: Retrieve a single category by its ID.
  • Create a Category: Create a new shop category.
  • Update a Category: Update an existing category.
  • Delete a Category: Delete a category by its ID.

Master Category​

  • List Master Categories: Retrieve the master category tree.
  • Get a Master Category: Retrieve a single master category by its ID.
  • Create a Master Category: Create a new master category.
  • Update a Master Category: Update an existing master category.
  • Delete a Master Category: Delete a master category by its ID.

Attribute Group​

  • List Attribute Groups: Retrieve a paginated list of attribute groups.
  • Get an Attribute Group: Retrieve a single attribute group by its name.
  • Create an Attribute Group: Create a new attribute group.
  • Update an Attribute Group: Update an existing attribute group.
  • Delete an Attribute Group: Delete an attribute group by its name.

Brand​

  • List Brands: Retrieve a paginated list of brands.
  • Get a Brand: Retrieve a single brand by its ID.
  • Create a Brand: Create a new brand.
  • Update a Brand: Update an existing brand.
  • Delete a Brand: Delete a brand by its ID.

Order​

  • List Orders: Retrieve the orders of a shop country.
  • Get an Order: Retrieve a single order by its ID.
  • Create an Order: Create a new order.
  • Delete an Order: Delete an order by its ID.
  • Get Order Status: Retrieve the status of an order.

Customer​

  • List Customers: Retrieve the customers of a shop country.
  • Get a Customer: Retrieve a single customer by its ID.
  • Create a Customer: Create a new customer.
  • Update a Customer: Update an existing customer.
  • Delete a Customer: Delete a customer by its ID.

Customer Segment​

  • List Customer Segments: Retrieve the customer segments of a shop country.
  • Get a Customer Segment: Retrieve a single customer segment by its ID.
  • Create a Customer Segment: Create a new customer segment.
  • Update a Customer Segment: Update an existing customer segment.
  • Delete a Customer Segment: Delete a customer segment by its ID.

Voucher​

  • List Vouchers: Retrieve the vouchers of a shop country.
  • Get a Voucher: Retrieve a single voucher by its ID.
  • Create a Voucher: Create a new voucher.
  • Update a Voucher: Update an existing voucher.
  • Delete a Voucher: Delete a voucher by its ID.

Promotion​

  • List Promotions: Retrieve a paginated list of promotions.
  • Get a Promotion: Retrieve a single promotion by its ID.
  • Create a Promotion: Create a new promotion.
  • Update a Promotion: Update an existing promotion.
  • Delete a Promotion: Delete a promotion by its ID.

Shop​

  • List Shops: Retrieve a paginated list of shops.
  • Get a Shop: Retrieve a single shop by its ID.
  • List Shop Countries: Retrieve the countries configured for a shop.

Fulfillment​

  • Create Shipment: Create a shipment.
  • Send Returns: Send return items.
  • Send Cancellations: Send cancellations.

Custom API​

  • Custom API: Run a custom SCAYLE Admin API request not covered by the other resources.

Further Reading​

For more information on the SCAYLE Admin API, refer to the official SCAYLE Admin API Documentation.