- common
- host
- customers
- customer-account-defaults
- default-customer
- frequent-customers
- store
- customers
- default-customer
- frequent-customers
Add Customer
Developing
POST
/customers
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Body Params application/json
Example
{
"franchiseId": 0,
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"billToAddress": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"billToCustomerId": 0,
"phone": "string",
"email": "string",
"shipTo": {
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"phone": "string",
"email": "string"
},
"signatureRequired": true,
"balanceDue": 0,
"creditLimit": 0,
"cashOverDays": true,
"cashOverLimit": true,
"maxDays": 0,
"defaultPayType": "CASH",
"payTypes": [
"CASH"
],
"priceCode": 0,
"taxCode": 0,
"status": "string"
}Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://mock.apidog.com/m1/365924-0-default/customers' \
--header 'Content-Type: application/json' \
--data-raw '{
"franchiseId": 0,
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"billToAddress": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"billToCustomerId": 0,
"phone": "string",
"email": "string",
"shipTo": {
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"phone": "string",
"email": "string"
},
"signatureRequired": true,
"balanceDue": 0,
"creditLimit": 0,
"cashOverDays": true,
"cashOverLimit": true,
"maxDays": 0,
"defaultPayType": "CASH",
"payTypes": [
"CASH"
],
"priceCode": 0,
"taxCode": 0,
"status": "string"
}'Responses
🟢201Created
application/json
Body
Example
{
"data": {
"customer": {
"id": 1,
"franchiseId": 1,
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"phone": "string",
"email": "string",
"billToAccount": {
"id": 0,
"status": "ACTIVE",
"billToAddress": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"balance": 0,
"creditLimit": 0,
"cashOverLimit": false,
"cashOverDays": false,
"ageInDays": 0,
"defaultPayType": "CASH",
"payTypes": [
"CASH"
],
"priceCode": 0,
"taxCode": "string",
"maxDays": 0,
"signatureRequired": false,
"version": 0
},
"shipTo": {
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"phone": "string",
"email": "string"
},
"version": 0
},
"account": {
"id": 0,
"status": "ACTIVE",
"billToAddress": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"balance": 0,
"creditLimit": 0,
"cashOverLimit": false,
"cashOverDays": false,
"ageInDays": 0,
"defaultPayType": "CASH",
"payTypes": [
"CASH"
],
"priceCode": 0,
"taxCode": "string",
"maxDays": 0,
"signatureRequired": false,
"version": 0
}
}
}🟠403Forbidden
🟠400Bad Request
🔴500Server Error
Modified at 2025-05-06 22:47:59