๐Introduction
Welcome to the SellSN API documentation!
Here, you'll find all of the details to start taking your integration with SellSN to the next level by leveraging our easy-to-use and quick REST-compliant API.
Quick links
We've gathered the most popular topics and grouped them all here for easy access, take a pick!
๐ชWebhooksBase configuration & standards
Before getting started, we highly recommend that you read and comply with the following steps to experience the best of the SellSN platform.
Base URL
The base URL for all API requests to SellSN is:
Authorization
We use Bearer tokens to authorize you to our API, you can generate an API key here. All API keys are immutable (read-only) once they have been issued.
In-order to ensure you're authorized correctly, make sure you enable only the scopes your app requires, keep your API key safe - treat it like a password!
To authorize you to the SellSN API, add the following header to all requests you wish to be authorized:
Also, we highly recommend that you set a user agent with every request - make it the name of your application or store. For example:
Responses
All responses issued by the API are in the same format, and always will return JSON.
We also only return a specific set of response codes from our API, find them below:
HTTP response code | Description |
---|---|
200/204 | The request was serviced and successful. |
201 | The request was serviced and some data has been created, it may be attached in the data property. |
400 | Bad request or validation error, something with the data provided is bad, check the message section for more details. |
401 | Not authorized, this means your API key is invalid. |
403 | Forbidden, your means of authorization is not sufficient for what you're doing - for example: updating a store without the |
404 | Not found, whichever entity you referenced by an ID or name could not be found. |
405 | Method not allowed, you used a HTTP request method that is not allowed for the specific endpoint. |
406/415 | You requested a response format that is not supported or you send a body that is not a supported media type. |
413/431 | You sent a body or header that is too large for us to process. |
429 | You're sending too many requests and have been put on a cooldown. Check the |
500 | Something went wrong whilst processing the request internally. These are reported straight back to us and are usually fixed within the day - if you receive this, report it to us and try again later. |
Last updated