POST /magento-stores.json

application/json

Body Required

apiPassword string | null

Api password
apiUsername string Required

Api username
archiveReason string | null Required

Archive reason

Values are subscription or other. Default value is other.
channelId integer(int32) Required

Channel
enabled boolean | null Required

Enabled

Default value is true.
lastFetchedSalesAt string(date-time) | null

Last fetched sales at
name string | null

Name
paidStatuses array[string] | null

Paid statuses
resourcePath string | null

Resource path
sendShipmentNotifications boolean | null Required

Send shipment notifications

Default value is true.
shop string Required

Shop
sourceLocation string | null

Source location
vendorField string | null

Vendor field

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- apiPassword string | null
  
  Api password
- apiUsername string Required
  
  Api username
- archiveReason string | null Required
  
  Archive reason
  
  Values are subscription or other. Default value is other.
- channelId integer(int32) Required
  
  Channel
- createdAt string(date-time)
  
  Created at
- enabled boolean | null Required
  
  Enabled
  
  Default value is true.
- id integer(int32)
  
  Id
- lastFetchedSalesAt string(date-time) | null
  
  Last fetched sales at
- name string | null
  
  Name
- paidStatuses array[string] | null
  
  Paid statuses
- resourcePath string | null
  
  Resource path
- sendShipmentNotifications boolean | null Required
  
  Send shipment notifications
  
  Default value is true.
- shop string Required
  
  Shop
- sourceLocation string | null
  
  Source location
- updatedAt string(date-time)
  
  Updated at
- vendorField string | null
  
  Vendor field

POST /magento-stores.json

curl \
 --request POST 'http://api.example.com/v1/magento-stores.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"apiPassword":"string","apiUsername":"string","archiveReason":"other","channelId":42,"enabled":true,"lastFetchedSalesAt":"2025-05-04T09:42:00Z","name":"string","paidStatuses":["string"],"resourcePath":"string","sendShipmentNotifications":true,"shop":"string","sourceLocation":"string","vendorField":"string"}'

Request examples

{
  "apiPassword": "string",
  "apiUsername": "string",
  "archiveReason": "other",
  "channelId": 42,
  "enabled": true,
  "lastFetchedSalesAt": "2025-05-04T09:42:00Z",
  "name": "string",
  "paidStatuses": [
    "string"
  ],
  "resourcePath": "string",
  "sendShipmentNotifications": true,
  "shop": "string",
  "sourceLocation": "string",
  "vendorField": "string"
}

Response examples (200)

{
  "apiPassword": "string",
  "apiUsername": "string",
  "archiveReason": "other",
  "channelId": 42,
  "createdAt": "2025-05-04T09:42:00Z",
  "enabled": true,
  "id": 42,
  "lastFetchedSalesAt": "2025-05-04T09:42:00Z",
  "name": "string",
  "paidStatuses": [
    "string"
  ],
  "resourcePath": "string",
  "sendShipmentNotifications": true,
  "shop": "string",
  "sourceLocation": "string",
  "updatedAt": "2025-05-04T09:42:00Z",
  "vendorField": "string"
}