Customers | API reference

Basic information

POST /{shopId}/customers

Creates a customer. If customerNumber is not provided in the request, it will be generated automatically.

Authorisation

OAuth 2.0 Token required with scopes:

customers_write

URI parameters

Name	Type	Description
`shopId`	string	The unique identifier of the shop. Required: `true` Example: `DemoShop`

Request attributes

Name	Type	Description
	object of customer (create request)

Request body

Media type application/json

{
  "customerNumber": "1005",
  "billingAddress": {
    "company": "Schneiderei",
    "salutation": "Mrs",
    "firstName": "Tanja",
    "lastName": "Schneider",
    "street": "Schneiderstraße 10",
    "streetDetails": null,
    "zipCode": "12345",
    "city": "Berlin",
    "state": null,
    "country": "DE",
    "title": null,
    "vatId": null,
    "birthday": null,
    "emailAddress": "schneider@schneiderei.de"
}

Response attributes

Name	Type	Description
	object of customer

Response

HTTP 201

Media type application/json

{
  "customerId": "56D80631-A052-FCA2-A9EF-D5809AB35510",
  "customerNumber": "1005",
  "creationDate": "2016-03-03T09:38:57Z",
  "billingAddress": null,
  "internalNote": null,
  "links": [
    {
      "rel": "self",
      "href": "https://pm.epages.com/rs/shops/apidocu/customers/56D80631-A052-FCA2-A9EF-D5809AB35510"
    },
    {
      "rel": "orders",
      "href": "https://pm.epages.com/rs/shops/apidocu/orders?customerId=56D80631-A052-FCA2-A9EF-D5809AB35510"
    }
  ]
}