Sales channels
Sales channels
Create of sales channel
You can set up a sales channel through our API. The type of sales channel is listed here, where you can choose from eshop, marketplace or store options. It depends on what purpose the given sales channel will be intended for. It is also possible to set its name, description, currency, country and others.
Endpoint [POST] /System/Channels/ on the API you can easily try.
You can find more information about the endpoint and its parameters in our API documentation
You can also use the API to load all sales channels in a given instance. This is used for setting up applications that we connect to Retailys in a given instance. To determine the instance, we use the token, which is used for authorization. There is an option to choose if we want an extended model that contains relatively more information than the basic one. In response, we will receive information about all sales channels that we can continue to work with.
Endpoint [GET] /System/Channels/ on the API you can easily try.
You can find more information about the endpoint and its parameters in our API documentation
Load a specific sales channel
You can also use the API to retrieve one specific sales channel in a given instance using its identifier and the token used for authorization. There is an option to choose if we want an extended model that contains relatively more information than the basic one. The response will return information about a specific sales channel that we can continue to work with.
Endpoint [GET] /System/Channels/{id} on the API you can easily try.
You can find more information about the endpoint and its parameters in our API documentation
Creating feeds for a specific sales channel
Our API also allows you to create a feed for a sales channel, which we identify with its identifier. The input will be the feed name and date.
Endpoint [POST] /System/Channels/{channelId/feeds} on the API you can easily try.
You can find more information about the endpoint and its parameters in our API documentation
Domains
Retrieve all sales channel domains that are in the instance
You can use the API to load all the sales channel domains that are in the instance. In the information received, we will find the domain name, whether it is a secure port and whether the domain has an alias.
Endpoint [GET] /System/Channels/Domains on the API you can easily try.
You can find more information about the endpoint and its parameters in our API documentation
Load a specific domain
Using the API, you can also load a specific domain using its identifier. We will also find the domain name in the information, whether it is a secure port and whether the domain has an alias.
Endpoint [GET] /System/Channels/Domains/{domainId} on the API you can easily try.
You can find more information about the endpoint and its parameters in our API documentation
Payment methods
Load all payment methods in the given sales channel
You can use the API to retrieve information about all payment methods in a given sales channel. In the information we get, for example, their name, description, price, currency, etc.
Endpoint [GET] /System/Channels/Payments on the API you can easily try.
You can find more information about the endpoint and its parameters in our API documentation
Loading a specific payment method
You can use the API to retrieve information about a specific payment method. In the information we get, for example, its name, description, price, currency, etc.
Endpoint [GET] /System/Channels/Payments/{paymentId} on the API you can easily try.
You can find more information about the endpoint and its parameters in our API documentation
Shipping methods
Reading of all shipping methods in a given sales channel
All shipping methods in a given sales channel can be loaded using the API. In the information we get information about the given shipping methods such as name, currency, price, description, etc.
Endpoint [GET] /System/Channels/Shippings on the API you can easily try.
You can find more information about the endpoint and its parameters in our API documentation
Loading a specific shipping method
You can also use the API to load a specific shipping method in a given sales channel. In the information we also get information about the given shipping method such as name, currency, price, description, etc.
Endpoint [GET] /System/Channels/Shippings/{shippingId} on the API you can easily try.
You can find more information about the endpoint and its parameters in our API documentation
Modification of the shipping method
You can also use the API to modify a specific shipping method, such as its name or description.
Endpoint [PUT] /System/Channels/Shippings/{shippingId} on the API you can easily try.
You can find more information about the endpoint and its parameters in our API documentation
Last updated