commerce

Embed

<a href="https://hermeticor.com/docs/ref-commerce"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/a95d6f25-c648-492d-bcb5-a74907109222/social-card.svg?v=3e7ae33eec8b" alt="commerce" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/commerce/stores/{storeId}/customers

Parameters

limitintegerquery

= 50

cursorstringquery

emailstringquery

storeIdstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/commerce/stores/{storeId}/customers" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "email": "string",
      "profileId": "string",
      "firstName": "string",
      "lastName": "string",
      "company": "string",
      "optInStatus": true,
      "address": {},
      "ordersCount": 0,
      "totalSpentMinor": 0,
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem141[]required

Show child parameters

idstringrequired

emailstringrequired

profileIdstringrequired

firstNamestringrequired

lastNamestringrequired

companystringrequired

optInStatusbooleanrequired

addressobjectrequired

ordersCountintegerrequired

totalSpentMinorintegerrequired

createdAtstringrequired

updatedAtstringrequired

nextCursorstringrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · GET /v1/commerce/stores/{storeId}/customers

POSThttps://hermeticor.com/v1/commerce/stores/{storeId}/customers

Parameters

storeIdstringpathrequired

Request body

application/json

idstringrequired

emailstringrequired

firstNamestring

lastNamestring

companystring

optInStatusboolean

addressobject

Show child parameters

namestring

address1string

address2string

citystring

provincestring

provinceCodestring

postalCodestring

countrystring

countryCodestring

phonestring

companystring

{
  "id": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "company": "string",
  "optInStatus": true,
  "address": {
    "name": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "province": "string",
    "provinceCode": "string",
    "postalCode": "string",
    "country": "string",
    "countryCode": "string",
    "phone": "string",
    "company": "string"
  }
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/commerce/stores/{storeId}/customers" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"string","email":"string","firstName":"string","lastName":"string","company":"string","optInStatus":true,"address":{"name":"string","address1":"string","address2":"string","city":"string","province":"string","provinceCode":"string","postalCode":"string","country":"string","countryCode":"string","phone":"string","company":"string"}}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "email": "string",
  "profileId": "string",
  "firstName": "string",
  "lastName": "string",
  "company": "string",
  "optInStatus": true,
  "address": {},
  "ordersCount": 0,
  "totalSpentMinor": 0,
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

emailstringrequired

profileIdstringrequired

firstNamestringrequired

lastNamestringrequired

companystringrequired

optInStatusbooleanrequired

addressobjectrequired

ordersCountintegerrequired

totalSpentMinorintegerrequired

createdAtstringrequired

updatedAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/commerce/stores/{storeId}/customers

5XX Default Response

Same as 4XX · GET /v1/commerce/stores/{storeId}/customers

GEThttps://hermeticor.com/v1/commerce/stores/{storeId}/customers/{customerId}

Parameters

storeIdstringpathrequired

customerIdstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/commerce/stores/{storeId}/customers/{customerId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/commerce/stores/{storeId}/customers

4XX Default Response

Same as 4XX · GET /v1/commerce/stores/{storeId}/customers

5XX Default Response

Same as 4XX · GET /v1/commerce/stores/{storeId}/customers

PUThttps://hermeticor.com/v1/commerce/stores/{storeId}/customers/{customerId}

Parameters

storeIdstringpathrequired

customerIdstringpathrequired

Request body

application/json

emailstringrequired

firstNamestring

lastNamestring

companystring

optInStatusboolean

addressobject

Show child parameters

namestring

address1string

address2string

citystring

provincestring

provinceCodestring

postalCodestring

countrystring

countryCodestring

phonestring

companystring

{
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "company": "string",
  "optInStatus": true,
  "address": {
    "name": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "province": "string",
    "provinceCode": "string",
    "postalCode": "string",
    "country": "string",
    "countryCode": "string",
    "phone": "string",
    "company": "string"
  }
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/commerce/stores/{storeId}/customers/{customerId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"string","firstName":"string","lastName":"string","company":"string","optInStatus":true,"address":{"name":"string","address1":"string","address2":"string","city":"string","province":"string","provinceCode":"string","postalCode":"string","country":"string","countryCode":"string","phone":"string","company":"string"}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/commerce/stores/{storeId}/customers

4XX Default Response

Same as 4XX · GET /v1/commerce/stores/{storeId}/customers

5XX Default Response

Same as 4XX · GET /v1/commerce/stores/{storeId}/customers

DELETEhttps://hermeticor.com/v1/commerce/stores/{storeId}/customers/{customerId}

Parameters

storeIdstringpathrequired

customerIdstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/commerce/stores/{storeId}/customers/{customerId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/commerce/stores/{storeId}/customers

5XX Default Response

Same as 4XX · GET /v1/commerce/stores/{storeId}/customers

PATCHhttps://hermeticor.com/v1/commerce/stores/{storeId}/customers/{customerId}

Parameters

storeIdstringpathrequired

customerIdstringpathrequired

Request body

application/json

emailstring

firstNamestring

lastNamestring

companystring

optInStatusboolean

addressobject

Show child parameters

namestring

address1string

address2string

citystring

provincestring

provinceCodestring

postalCodestring

countrystring

countryCodestring

phonestring

companystring

{
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "company": "string",
  "optInStatus": true,
  "address": {
    "name": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "province": "string",
    "provinceCode": "string",
    "postalCode": "string",
    "country": "string",
    "countryCode": "string",
    "phone": "string",
    "company": "string"
  }
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/commerce/stores/{storeId}/customers/{customerId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"string","firstName":"string","lastName":"string","company":"string","optInStatus":true,"address":{"name":"string","address1":"string","address2":"string","city":"string","province":"string","provinceCode":"string","postalCode":"string","country":"string","countryCode":"string","phone":"string","company":"string"}}'

TypeScript

Python

PHP

Ruby

Java