Change several products

POST

/products/bulk

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

One change made to every product named: on or off the business’s shop, into or out of a category, archived or restored. Each is done by the same rules as editing it alone. One the change does not apply to, or that is already that way, is left as it is and listed as skipped; the rest still go.

Authorizations

• sessionCookie
  products:write
• apiKey
  products:write

Request Body^required

Media typeapplication/json

object

productIds

required

Array<string>

>= 1 items <= 1000 items

change

required

One of:

object

object

action

required

Put each on the business’s own shop. Deposits, rent and archived products are skipped.

string

Allowed values: publish

object

object

action

required

Take each off the business’s shop.

string

Allowed values: unpublish

object

object

action

required

Say who may buy each on the shop: everybody, consumers only or trade customers only. Deposits and rent are skipped.

string

Allowed values: shopAudience

audience

required

Who may buy it on the shop once published. both: everybody (the default). consumer: anybody not signed in for a trade account, so trade customers do not see it. trade: signed-in trade customers only.

string

Allowed values: both consumer trade

object

object

action

required

Keep each off new orders and off the shop. Old orders are left alone.

string

Allowed values: archive

object

object

action

required

Bring each back from the archive. It stays off the shop until put back. A deposit or rent that would clash with a live one is skipped.

string

Allowed values: restore

object

object

action

required

Add each to the category, keeping the others it is in. Deposits and rent are skipped.

string

Allowed values: addCategory

categoryId

required

UUID v7

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

object

object

action

required

Take each out of the category, leaving the others it is in.

string

Allowed values: removeCategory

categoryId

required

UUID v7

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

object

object

action

required

Put each in the gas type, or in none with null. Deposits and rent are skipped: they are moved on their own form.

string

Allowed values: setGasType

gasTypeId

required

UUID v7

string | null format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

Responses

200

What was changed and what was skipped

Media typeapplication/json

object

done

required

Array<object>

object

productId

required

UUID v7

string format: uuid

name

required

string

skipped

required

Array<object>

object

productId

required

UUID v7

string format: uuid

name

required

string | null

reason

required

string

Allowed values: not_found archived charge clash unchanged

Example

{
  "done": [
    {
      "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ],
  "skipped": [
    {
      "productId": "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, or without the permission this needs

Media typeapplication/json

object

error

required

string

message

required

string

Example

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

404

The category is not one of this business’s

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"
    }
  ]
}