Supported Scayle APIs

Assets

Upload an asset

X

Products

Get products for given filters

X

Create a new shop product

X

Get a product

X

Update an existing product

X

Delete a product

X

Update state of an existing product

X

Create or update first live at for all the variants of a product.

X

Images

Get product images

X

Create a new product image

X

Update a product image position

X

Delete a product image

X

Variants

Get product variants

X

Create a new shop product variant

X

Get a product variant

X

Update an existing product variant

X

Delete a product variant

X

Product custom data

Get custom data for a product

X

Create or update custom data for a product

X

Delete custom data for a product

X

Get data of a key in custom data for a product

X

Create or update specific key of custom data for a product

X

Delete a key of custom data for a product

X

Composite products

Create a new shop composite product

X

Update an existing composite product

X

Delete a composite product

X

Composite product variants

Create a new shop composite product variant

X

Update an existing composite product variant

X

Delete a composite product variant

X

Product master

Update the master categories of product master

X

Attributes

Get product master attributes

X

Update or create a product master attribute

X

Get a product master attribute

X

Delete a product master attribute.

X

Get product attributes

X

Update or create a product attribute

X

Get a product attribute

X

Delete a product attribute

X

Get product variant attributes

X

Update or create a product variant attribute

X

Get a product variant attribute

X

Delete a product variant attribute

X

Get product image attributes

X

Update or create a product image attribute

X

Get a product image attribute

X

Delete a product image attribute

X

Product variant custom data

Get custom data for a product variant

X

Create or update custom data for a product variant

X

Delete custom data for a product variant

X

Get product variant custom data for a specific key

X

Create or update specific key of custom data of a product variant

X

Delete product variant custom data for a specific key

X

Prices

Get all product variant prices

X

Update or create a product variant price

X

Delete a product variant price

X

Stocks

Get product variant stock information

X

Create new product variant stock information

X

Master categories

Update product master categories

X

Get master categories for given filters

X

Create a new master category

X

Get master category by ID

X

Update an existing master category

X

Delete a master category

X

Translations

Update or create simple attribute translations

X

Get attribute translations

X

Shops

Create a new shop

X

Get shops for given filters

X

Get a shop by key

X

Update an existing shop

X

Update a shop country assortment

X

Create a new shop country

X

Get shop countries for given filters

X

Get a shop country by code

X

Update an existing shop country

X

Attribute groups

Get attribute groups for given filters

X

Create a new attribute group

X

Get an attribute group

X

Update an existing attribute group

X

Delete an attribute group

X

Update frontend name for an existing attribute group

X

Get attributes for given attribute group.

X

Create an unattached attribute for the given attribute group.

X

Update the given attribute.

X

Delete an attribute

X

Campaigns

Get campaigns for given filters

X

Create a new campaign

X

Get a campaign

X

Update an existing campaign

X

Delete a campaign

X

Create or update campaign product variant reductions

X

Get variant reduction for given campaign

X

Create or update campaign product reductions

X

Delete all or specific campaign reductions

X

Shop categories

Get shop categories for given filters

X

Create a new shop category

X

Get a shop category

X

Update an existing shop category

X

Delete a shop category

X

Unlink referencing product sets

X

Get shop category properties

X

Update or create a shop category property

X

Delete a shop category property

X

Get a shop category property

X

Get shop category country configuration

X

Create or update a shop category country configuration

X

Get shop category property keys

X

Create a new shop category property key

X

Get a shop category property key

X

Update an existing shop category property key

X

Delete a shop category property key

X

Shop categories custom data

Get custom data for a shop category

X

Create or update custom data for a shop category

X

Delete custom data for a shop category

X

Get data of a key in custom data for a shop category

X

Create or update a specific custom data key for a shop category

X

Delete custom data key for a shop category

X

Shop categories country custom data

Get custom data for a shop category country

X

Create or update custom data for a shop category country

X

Delete custom data for a shop category country

X

Get data of custom data key for a shop category country

X

Create or update a specific custom data key for a shop category country

X

Delete custom data key for a shop category country

X

Shop country custom data

Get custom data for a shop country

X

Create or update custom data for a shop country

X

Delete custom data for a shop country

X

Get shop country data for a specific key

X

Create or update shop country custom data for a specific key

X

Delete a key of custom data for a shop country

X

Shop custom data

Get custom data for a shop

X

Create or update custom data for a shop

X

Delete custom data for a shop

X

Get shop custom data for a specific key

X

Create or update shop custom data for a specific key

X

Delete shop custom data for a specific key

X

Warehouses

Attach a warehouse to a shop country

X

Update an existing shop country warehouse relation

X

Detach a warehouse from a shop country

X

Get merchant warehouses for given filters

X

Attach a warehouse to a merchant

X

Detach a warehouse from a merchant

X

Create a new warehouse

X

Get warehouses for given filters

X

Delete a warehouse

X

Shop country price roundings

Create a new price rounding

X

Get price roundings.

X

Delete a price rounding

X

Package groups

Get a collection of package groups assigned to given shop

X

Delete a package group

X

Assign a package group to a list of shop warehouses

X

Replace a package group for a list of shop warehouses

X

Brands

Get a brand

X

Update an existing brand

X

Delete a brand

X

Create a new brand

X

Get brands for given filters

X

Brand custom data

Get custom data for a brand

X

Create or update custom data for a brand

X

Delete custom data for a brand

X

Get data of a key in custom data for a brand

X

Create or update specific key of custom data for a brand

X

Delete a key of custom data for a brand

X

Campaign custom data

Get custom data for a campaign

X

Create or update custom data for a campaign

X

Delete custom data for a campaign

X

Get campaign custom data for a specific key

X

Create or update specific key of custom data of a campaign

X

Delete campaign custom data for a specific key

X

Product sortings

Create or update product sortings

X

Delete product sortings

X

Custom data config

Create a new custom data config

X

Get custom data config

X

Update an existing custom data config

X

Delete custom data config

X

Customers

Create a new customer

X

Get customers for given filters

X

Get a customer

X

Update an existing customer

X

Update customer reference key

X

Set a password for a customer

X

Set a password hash for a customer

X

Anonymize a customer

X

Get a customer status

X

Update an existing customer status

X

Get customer addresses

X

Create a new customer address

X

Create a new customer groups

X

Delete customer group

X

Create a new customer membership

X

Get customer memberships

X

Delete a customer membership

X

Update an existing customer membership

X

Get explicit customer address

X

Update a customer address

X

Update a customer address reference key

X

Anonymize a customer address

X

Anonymize a customer address

X

Reset customer password

X

Orders

Get orders for given filters

X

Create an order

X

Get a order

X

Delete an order

X

Update order reference key

X

Get an order status

X

Fulfillment

Create a new shipment

X

Send a cancellation

X

Return items

X

Webhooks

Return all available webhook events that are exposed by the system

X

Return all registered webhook subscriptions

X

Create a new webhook subscription

X

Return a registered webhook subscription

X

Delete an existing webhook subscription

X

Vouchers

Get a voucher

X

Update an existing voucher

X

Delete a voucher

X

Create a new voucher

X

Get vouchers for given filters

X

Get a voucher criterion

X

Update an existing voucher criterion

X

Delete a voucher criterion

X

Get voucher criteria

X

Add new criterion to the voucher

X

Companies

Get companies

X

Create a new company

X

Get a company

X

Update an existing company

X

Carriers

Create a new carrier

X

Get carriers for given filters

X

Get a carrier

X

Update an existing carrier

X

Merchants

Create a new merchant

X

Get merchants for given filters

X

Get a merchant

X

Update an existing merchant

X

Create a new contact

X

Get contacts for given filters

X

Get a contact

X

Update an existing contact

X

Delete a contact

X

Create a new return address

X

Get return addresses for given filters

X

Get a return address

X

Update an existing return address

X

Delete a return address

X

Attach a carrier to a merchant

X

Detach a carrier from a merchant

X

Promotions

Get promotions for given filters

X

Create a promotion

X

Get a promotion

X

Delete a promotion

X

Update an existing promotion

X

Create a promotion

X

Update a promotion

X

Get audiences for given filters

X

Create a new audience

X

Get an audience

X

Delete an audience

X

Update an audience

X

Reservations

Create new reservations

X

Delete a reservation

X

Baskets

Get a basket

X

Add a variant

X

Update an item

X

Delete an item

X

Variants

List variants

X

Get a variant

X

Products

List products

X

Get a product

X

Categories

List categories

X

Get a category

X

Attributes

List attributes

X

Get an attribute

X

Campaigns

List campaigns

X

Get a campaign

X

Search

Resolve v1

X

Typeahead v1

X

Suggestions v2

X

Resolve v2

X

Filters

List filters

X

List values

X

Wishlists

Get a wishlist

X

Add an item

X

Remove a item

X

Shop Configuration

Get the configuration

X

Navigation

List navigation trees

X

Get a navigation tree

X

Brands

List brands

X

Get a brand

X

Redirects

List redirects

X

Match redirect

X

Promotions

List promotions

X

Pages

List pages

X

Get a page

X