Get Customer - Customer API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

Body

Example

{
    "data": {
        "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
    }
}

🟠404Not Found

🟠403Forbidden