GET /woo-commerce-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
- archiveReason string | null Required
  
  Archive reason
  
  Values are subscription or other. Default value is other.
- channelId integer(int32) Required
  
  Channel
- consumerKey string Required
  
  Consumer key
- consumerSecret string Required
  
  Consumer secret
- createdAt string(date-time)
  
  Created at
- customerNote boolean | null Required
  
  Customer note
  
  Default value is false.
- customerNoteContent string | null
  
  Customer note content
- enabled boolean | null Required
  
  Enabled
  
  Default value is true.
- id integer(int32)
  
  Id
- importDraftProducts boolean | null Required
  
  Import draft products
  
  Default value is true.
- importingProducts boolean | null
  
  Importing products
- lastFetchedProductsAt string(date-time) | null
  
  Last fetched products at
- lastFetchedSalesAt string(date-time) | null
  
  Last fetched sales at
- legacy boolean | null Required
  
  Legacy
  
  Default value is false.
- name string | null
  
  Name
- partialShipmentStatus string | null Required
  
  Partial shipment status
  
  Values are processing or completed. Default value is completed.
- shop string Required
  
  Shop
- suffix string | null
  
  Suffix
- updatedAt string(date-time)
  
  Updated at
- vendorField string | null
  
  Vendor field
- vendorMapping string | null Required
  
  Vendor mapping
  
  Values are attribute or custom. Default value is attribute.

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

Response examples (200)

{
  "archiveReason": "other",
  "channelId": 42,
  "consumerKey": "string",
  "consumerSecret": "string",
  "createdAt": "2024-05-04T09:42:00+00:00",
  "customerNote": false,
  "customerNoteContent": "string",
  "enabled": true,
  "id": 42,
  "importDraftProducts": true,
  "importingProducts": true,
  "lastFetchedProductsAt": "2024-05-04T09:42:00+00:00",
  "lastFetchedSalesAt": "2024-05-04T09:42:00+00:00",
  "legacy": false,
  "name": "string",
  "partialShipmentStatus": "completed",
  "shop": "string",
  "suffix": "string",
  "updatedAt": "2024-05-04T09:42:00+00:00",
  "vendorField": "string",
  "vendorMapping": "attribute"
}