Manage Merchants
General
When creating a new merchant you can specify its name, a reference key and an optional priority parameter. After creating a merchant, you can additionally configure contact information, carriers and return addresses, using the dedicated endpoints. Please also find the next sections for more details.
Admin API
Create Merchant
When creating a merchant, you need to define a name, a reference key and optionally a priority.
| Parameter | Details |
|---|---|
id | Integer READ-ONLY The ID of the merchant created by SCAYLE. |
referenceKey | String Reference key of the merchant. |
name | String Name of the merchant. |
priority | Integer Priority of the merchant. |
Update Merchant
This method is used to update an existing merchant.
| Parameter | Details |
|---|---|
id | Integer READ-ONLY The ID of the merchant created by SCAYLE. |
referenceKey | String Reference key of the merchant. |
name | String Name of the merchant. |
priority | Integer Priority of the merchant. |
Get Merchant
You can get merchant information by its reference key or ID.
| Parameter | Details |
|---|---|
with | String Allows to load the following nested resources within this request:
|
Get a Collection of Merchants
You can request multiple merchants and refine the search results by applying filter options.
| Parameter | Details |
|---|---|
limit | Integer Maximum number of items in the result. (default: |
filters[id] | String Comma-separated list of merchant IDs that should be used for filtering. |
filters[minId] | Integer Minimum ID of merchants that should be returned. |
filters[maxId] | Integer Maximum ID of merchants that should be returned. |
with | String Allows to load the following nested resources within this request:
|
| Parameter | Details |
|---|---|
entities | Merchant A collection of merchants. |
cursor | Cursor An object containing information for use in pagination. |
Get a List of 10 Merchants
Merchant Contacts
Create Merchant Contact
You can add multiple contacts to a merchant.
| Parameter | Details |
|---|---|
id | Integer READ-ONLY The ID of the contact created by SCAYLE. |
name | String The name of the contact. |
email | String The email of the contact. |
phone | String The phone of the contact. |
cellPhone | String The cell phone of the contact. |
type | String The type of the contact. |
position | String The position of the contact. |
description | String The description of the contact. |
Get a Merchant Contact
You can get merchant contact information by its ID.
Get a Collection of Merchant Contacts
| Parameter | Details |
|---|---|
limit | Integer Maximum number of items in the result. (default: |
filters[id] | String Comma-separated list of merchant contact IDs that should be used for filtering. |
filters[minId] | Integer Minimum ID of merchant contacts that should be returned. |
filters[maxId] | Integer Maximum ID of merchant contacts that should be returned. |
| Parameter | Details |
|---|---|
entities | MerchantContact A collection of merchant contacts. |
cursor | Cursor An object containing information for use in pagination. |
Update Merchant Contact
| Parameter | Details |
|---|---|
id | Integer READ-ONLY The ID of the contact created by SCAYLE. |
name | String The name of the contact. |
email | String The email of the contact. |
phone | String The phone of the contact. |
cellPhone | String The cell phone of the contact. |
type | String The type of the contact. |
position | String The position of the contact. |
description | String The description of the contact. |
Delete Merchant Contact
| Parameter | Details |
|---|---|
id | Integer READ-ONLY The ID of the contact created by SCAYLE. |
name | String The name of the contact. |
email | String The email of the contact. |
phone | String The phone of the contact. |
cellPhone | String The cell phone of the contact. |
type | String The type of the contact. |
position | String The position of the contact. |
description | String The description of the contact. |
