GET /magento-stores/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

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

curl \
 -X GET http://api.example.com/v1/magento-stores/{id}.json \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

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