Sales

Sales channels

The sales channels operations of the Core API.

Base URL: https://api.miridia.io. Read Authentication and Conventions before you call these operations.

Method	Path	Operation
GET	`/api/v1/SalesChannels`	Get all sales channels
GET	`/api/v1/SalesChannels/{salesChannelId}`	Get sales channel

Get all sales channels

GET/api/v1/SalesChannels

Access. Send a bearer token or an API key. The caller needs the Settings view permission.

Response

200. Returns a JSON array. Each item is SalesChannelResponse.

Request

curl -X GET "https://api.miridia.io/api/v1/SalesChannels" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "title": "string",
    "kind": "Direct",
    "defaultLocationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
]

Get sales channel

GET/api/v1/SalesChannels/{salesChannelId}

Access. Send a bearer token or an API key. The caller needs the Settings view permission.

Parameters

Name	In	Type	Required	Description
`salesChannelId`	path	`string (uuid)`	Yes

Response

200. Returns a SingleResult envelope. The data field is SalesChannelResponse.

Request

curl -X GET "https://api.miridia.io/api/v1/SalesChannels/{salesChannelId}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "title": "string",
    "kind": "Direct",
    "defaultLocationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Models

The operations on this page use these object types. Select a type to see its fields.

SalesChannelResponse

Field	Type	Description
`id`	`string (uuid)`
`title`	`string`
`kind`	`enum SalesChannelKind`	One of: `Direct`, `PointOfSale`, `Online`, `Marketplace`.
`defaultLocationId`	`string (uuid)`

Customer groups

The customer groups operations of the Core API.

Shipments

The shipments operations of the Core API.