Customer

Browse

POST/api/gateway/v2/customer/browse

Browse through the customers

Request Body

application/json

Paging/filter options

TypeScript Definitions

Use the request body type in TypeScript.

pageNumber*integer

Current page number

pageSize*integer

Gets or sets the page size.

textFilter?|

Gets or sets the text search filter.

debtorCode?|

Gets or sets the debtor code to filter by.

deliveryCode?|

Gets or sets the delivery code to filter by.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/customer/browse" \  -H "Content-Type: application/json" \  -d '{    "pageNumber": 1,    "pageSize": 1  }'

{  "items": [    {      "id": "string",      "entityId": 0,      "code": "string",      "companyName": "string",      "deliveryAddress": {        "type": "UNKNOWN",        "city": "string",        "countryCode": "st",        "emailAddress": "string",        "name": "string",        "phoneNumber": "string",        "address": "string",        "zip": "string",        "extraAddressLine": "string",        "extraAddressLine2": "string",        "state": "string"      },      "deliveryCode": "string",      "displayName": "string",      "emailAddress": "string",      "fax": "string",      "title": "string",      "firstName": "string",      "invoiceAddress": {        "type": "UNKNOWN",        "city": "string",        "countryCode": "st",        "emailAddress": "string",        "name": "string",        "phoneNumber": "string",        "address": "string",        "zip": "string",        "extraAddressLine": "string",        "extraAddressLine2": "string",        "state": "string"      },      "lastName": "string",      "mainAddress": {        "type": "UNKNOWN",        "city": "string",        "countryCode": "st",        "emailAddress": "string",        "name": "string",        "phoneNumber": "string",        "address": "string",        "zip": "string",        "extraAddressLine": "string",        "extraAddressLine2": "string",        "state": "string"      },      "middleName": "string",      "mobile": "string",      "phone": "string",      "website": "string",      "searchName": "string"    }  ],  "totalItemCount": 0}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

Store customer

POST/api/gateway/v2/customer/storecustomer

Inserts or updates the customer (depends on if the Id is set)

Request Body

application/json

The customer to insert/update

TypeScript Definitions

Use the request body type in TypeScript.

Contains information about the customer.

id?|

Unique ID.

Set to NULL when inserting a new Customer
Set to a valid ID when updating a Customer

entityId?integer

Entity ID (Always use the Id field for API communication)

code?|

Gets or sets the debtor code of the customer. This field is usually threated as readonly.

companyName?|

Gets or sets the name of a company associated with the customer if applicable.

deliveryAddress?

Gets or sets the delivery address.

deliveryCode?|

Gets or sets the delivery code. This field is usually treated as readonly.

displayName?|

Gets or sets a display friendly name.

emailAddress?|

Gets or sets the e-mail address.

fax?|

Gets or sets the fax number.

title?|

Gets or sets the title.

firstName?|

Gets or sets the first name.

invoiceAddress?

Gets or sets the invoice address.

lastName?|

Gets or sets the last name.

mainAddress?

Gets or sets the main address.

middleName?|

Gets or sets the middle name.

mobile?|

Gets or sets the mobile number.

phone?|

Gets or sets the phone number.

website?|

Gets or sets the website address.

searchName?|

Gets or sets the search name.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/v2/customer/storecustomer" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "entityId": 0,  "code": "string",  "companyName": "string",  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryCode": "string",  "displayName": "string",  "emailAddress": "string",  "fax": "string",  "title": "string",  "firstName": "string",  "invoiceAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "lastName": "string",  "mainAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "middleName": "string",  "mobile": "string",  "phone": "string",  "website": "string",  "searchName": "string"}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

Get customer by id

GET/api/gateway/v2/customer/getbyid

Searches for a customer with specified id

Query Parameters

id*string

The customer id

Response Body

`application/json`

curl -X GET "https://example.com/api/gateway/v2/customer/getbyid?id=string"

{  "id": "string",  "entityId": 0,  "code": "string",  "companyName": "string",  "deliveryAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryCode": "string",  "displayName": "string",  "emailAddress": "string",  "fax": "string",  "title": "string",  "firstName": "string",  "invoiceAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "lastName": "string",  "mainAddress": {    "type": "UNKNOWN",    "city": "string",    "countryCode": "st",    "emailAddress": "string",    "name": "string",    "phoneNumber": "string",    "address": "string",    "zip": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "middleName": "string",  "mobile": "string",  "phone": "string",  "website": "string",  "searchName": "string"}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

200application/json

400application/json

200application/json

400application/json

200application/json

400application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`