Add & Provision Customer

Developing

POST

/customers

Adds the customer and also provisions it for the store.

This op is intended to be called only by the ACL.

In order to prevent race conditions with the ACL, it does NOT automatically publish the state of the newly added customer.

The ACL triggers the event publish via a separate publish-customer-state op once the ACL is done adding the legacy customer.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/json

Example

{
    "customer": {
        "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"
    },
    "provisioning": {
        "storeCustomerNumber": "string",
        "version": 0
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://mock.apidog.com/m1/365924-0-default/customers' \
--header 'add_andProvision;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customer": {
        "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"
    },
    "provisioning": {
        "storeCustomerNumber": "string",
        "version": 0
    }
}'

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-16 17:11:32

Add Customer

Add Customers