Change several customers

POST

/customers/bulk

curl --request POST \
  --url https://example.com/customers/bulk \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "customerIds": [ "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" ], "change": { "action": "kind", "kind": "commercial" } }'

One change made to every customer named: trade or consumer, payment terms, stopping new orders while unpaid, the chosen or excluded list for the surcharge, the language of their emails, or archiving. Each is done by the same rules as editing it alone. One that is archived, missing or already that way is left as it is and listed as skipped; the rest still go. To move many onto a price list, use POST /customers/rate-set.

Authorizations

• sessionCookie
  customers:write
• apiKey
  customers:write

Request Body^required

Media typeapplication/json

object

customerIds

required

Array<string>

>= 1 items <= 1000 items

change

required

One of:

object

object

action

required

Make each a trade (commercial) or consumer (domestic) customer.

string

Allowed values: kind

kind

required

string

Allowed values: commercial domestic

object

object

action

required

How each pays: prepaid, on account (with how many days, null for the business default) or cash on delivery.

string

Allowed values: paymentTerms

paymentTerms

required

string

Allowed values: prepaid on_account cash_on_delivery

paymentTermsDays

required

integer | null

<= 120

object

object

action

required

Whether new orders stop while each has an overdue invoice.

string

Allowed values: blockNewOrdersWhenUnpaid

on

required

boolean

object

object

action

required

Put each on the chosen or excluded list for the business surcharge, or take them off with null.

string

Allowed values: surchargeRule

rule

required

string | null

Allowed values: add exclude

object

object

action

required

The language emails to each are written in.

string

Allowed values: locale

locale

required

A language: en-GB English, ar Arabic, ur Urdu, pa Punjabi (Gurmukhi), hi Hindi, bn Bengali, gu Gujarati, zh-Hans Chinese (Simplified), pl Polish, ro Romanian, es Spanish, fr French, de German.

string

Allowed values: en-GB ar ur pa hi bn gu zh-Hans pl ro es fr de

object

object

action

required

Take each off the customer list. Past orders and invoices keep them. Already archived ones are skipped.

string

Allowed values: archive

Responses

200

What was changed and what was skipped

Media typeapplication/json

object

done

required

Array<object>

object

customerId

required

UUID v7

string format: uuid

name

required

string

skipped

required

Array<object>

object

customerId

required

UUID v7

string format: uuid

name

required

string | null

reason

required

string

Allowed values: not_found archived unchanged

Example

{
  "done": [
    {
      "customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ],
  "skipped": [
    {
      "customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "reason": "not_found"
    }
  ]
}

401

Not signed in

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not a member of that tenant

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Validation failed

Media typeapplication/json

object

error

required

string

Allowed values: validation

message

required

string

issues

required

Array<object>

object

path

required

string

message

required

string

Example

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}