Medusa

Create a Sales Channel

POST

/admin/sales-channels

Sales Channels

Create a Sales Channel.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.medusa-commerce.com/admin/sales-channels' \
--header 'Content-Type: application/json' \
--data-raw ''

Response Example

200 - Example 1

{
  "sales_channel": {
    "id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A",
    "name": "Market",
    "description": "Multi-vendor market",
    "is_disabled": false,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "deleted_at": "2019-08-24T14:15:22Z",
    "metadata": {
      "car": "white"
    },
    "locations": [
      {
        "id": "scloc_01G8X9A7ESKAJXG2H0E6F1MW7A",
        "sales_channel_id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A",
        "location_id": "string",
        "sales_channel": {},
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z"
      }
    ]
  }
}

Request

Body Params application/json

name

string

required

The name of the Sales Channel

description

string

optional

The description of the Sales Channel

is_disabled

boolean

optional

Whether the Sales Channel is disabled.

Examples

Responses

🟢200OK

application/json

Body

sales_channel

object (Sales Channel)

required

A Sales Channel is a method a business offers its products for purchase for the customers. For example, a Webshop can be a sales channel, and a mobile app can be another.

string

required

The sales channel's ID

Example:

sc_01G8X9A7ESKAJXG2H0E6F1MW7A

name

string

required

The name of the sales channel.

Example:

Market

description

string | null

required

The description of the sales channel.

Example:

Multi-vendor market

is_disabled

boolean

required

Specify if the sales channel is enabled or disabled.

Default:

false

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

deleted_at

string <date-time> | null

required

The date with timezone at which the resource was deleted.

metadata

object | null

optional

An optional key-value map with additional details

Example:

{"car":"white"}

locations

array[object (Sales Channel Stock Location) {7}]

optional

The details of the stock locations related to the sales channel.

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

Modified at 2023-10-10 11:56:36

Add Products to Sales Channel

List Sales Channels