POST /big-commerce-stores.json

POST /big-commerce-stores.json
application/json

Body Required

  • accessToken string | null

    Access token

  • archiveReason string | null Required

    Archive reason

    Values are subscription or other. Default value is other.

  • authenticationType string | null Required

    Authentication type

    Values are public or private. Default value is public.

  • channelId integer(int32) Required

    Channel

  • clientId string | null

    Client

  • clientSecret string | null

    Client secret

  • defaultCategory string | null

    Default category

  • enabled boolean | null Required

    Enabled

    Default value is true.

  • externalChannelId string | null

    External channel

  • importCancelledOrders boolean | null

    Import cancelled orders

  • lastFetchedSalesAt string(date-time) | null

    Last fetched sales at

  • name string | null

    Name

  • orderPolling boolean | null

    Order polling

  • shop string Required

    Shop

  • singleVariantPricingUpdate string | null Required

    For single variant products, should the price be updated on the product, variant or both?

    Values are product, variant, or both. Default value is variant.

  • storeHash string | null

    Store hash

  • useTotalTax boolean | null

    Use total tax

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • accessToken string | null

      Access token

    • archiveReason string | null Required

      Archive reason

      Values are subscription or other. Default value is other.

    • authenticationType string | null Required

      Authentication type

      Values are public or private. Default value is public.

    • channelId integer(int32) Required

      Channel

    • clientId string | null

      Client

    • clientSecret string | null

      Client secret

    • createdAt string(date-time)

      Created at

    • defaultCategory string | null

      Default category

    • enabled boolean | null Required

      Enabled

      Default value is true.

    • externalChannelId string | null

      External channel

    • id integer(int32)

      Id

    • importCancelledOrders boolean | null

      Import cancelled orders

    • lastFetchedSalesAt string(date-time) | null

      Last fetched sales at

    • name string | null

      Name

    • orderPolling boolean | null

      Order polling

    • shop string Required

      Shop

    • singleVariantPricingUpdate string | null Required

      For single variant products, should the price be updated on the product, variant or both?

      Values are product, variant, or both. Default value is variant.

    • storeHash string | null

      Store hash

    • updatedAt string(date-time)

      Updated at

    • useTotalTax boolean | null

      Use total tax

POST /big-commerce-stores.json
curl \
 --request POST 'http://api.example.com/v1/big-commerce-stores.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"accessToken":"string","archiveReason":"other","authenticationType":"public","channelId":42,"clientId":"string","clientSecret":"string","defaultCategory":"string","enabled":true,"externalChannelId":"string","importCancelledOrders":true,"lastFetchedSalesAt":"2025-05-04T09:42:00Z","name":"string","orderPolling":true,"shop":"string","singleVariantPricingUpdate":"variant","storeHash":"string","useTotalTax":true}'
Request examples
{
  "accessToken": "string",
  "archiveReason": "other",
  "authenticationType": "public",
  "channelId": 42,
  "clientId": "string",
  "clientSecret": "string",
  "defaultCategory": "string",
  "enabled": true,
  "externalChannelId": "string",
  "importCancelledOrders": true,
  "lastFetchedSalesAt": "2025-05-04T09:42:00Z",
  "name": "string",
  "orderPolling": true,
  "shop": "string",
  "singleVariantPricingUpdate": "variant",
  "storeHash": "string",
  "useTotalTax": true
}
Response examples (200)
{
  "accessToken": "string",
  "archiveReason": "other",
  "authenticationType": "public",
  "channelId": 42,
  "clientId": "string",
  "clientSecret": "string",
  "createdAt": "2025-05-04T09:42:00Z",
  "defaultCategory": "string",
  "enabled": true,
  "externalChannelId": "string",
  "id": 42,
  "importCancelledOrders": true,
  "lastFetchedSalesAt": "2025-05-04T09:42:00Z",
  "name": "string",
  "orderPolling": true,
  "shop": "string",
  "singleVariantPricingUpdate": "variant",
  "storeHash": "string",
  "updatedAt": "2025-05-04T09:42:00Z",
  "useTotalTax": true
}