POST /woo-commerce-stores.json

Bearer auth

application/json

Body Required

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
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.
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
vendorField string | null

Vendor field
vendorMapping string | null Required

Vendor mapping

Values are attribute or custom. Default value is attribute.

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.

POST /woo-commerce-stores.json

curl \
 --request POST 'http://api.example.com/v1/woo-commerce-stores.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"archiveReason":"other","channelId":42,"consumerKey":"string","consumerSecret":"string","customerNote":false,"customerNoteContent":"string","enabled":true,"importDraftProducts":true,"importingProducts":true,"lastFetchedProductsAt":"2025-05-04T09:42:00Z","lastFetchedSalesAt":"2025-05-04T09:42:00Z","legacy":false,"name":"string","partialShipmentStatus":"completed","shop":"string","suffix":"string","vendorField":"string","vendorMapping":"attribute"}'

Request examples

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

Response examples (200)

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