API ReferenceapicommercePOST /v1/admin/sync/customer-profiles

POST /v1/admin/sync/customer-profiles

Service: commerce · operationId: (none)

Sync customer profiles from platform to BigCommerce

Required scopes

(no scope declared — review service config)

Responses

200 Sync completed

{
  "type": "object",
  "properties": {
    "synced": {
      "type": "integer"
    },
    "skipped": {
      "type": "integer"
    },
    "errors": {
      "type": "integer"
    }
  },
  "required": [
    "synced",
    "skipped",
    "errors"
  ]
}

500 Internal error

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

Example

curl -X POST https://commerce.platform.loop.health/v1/admin/sync/customer-profiles \
  -H "Authorization: Bearer $ACCESS_TOKEN"