[lightMode]

Update Bulk Quantities

POST/products/quantities/bulk

[updatedIn] 2 months ago

This endpoint allows you to update unlimited bulk quantities by providing the IDs of the products you want to update its quantity in your body request, where it will process the update procedure and then execute later on.

`products.read_write`- Products Read & Write

Request

Authorization: OAuth 2.0

Add the parameter

Authorization

to [header]，whose value is to concatenate the Token after the Bearer.

[api.label.example]

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

products

array [object {7}]

required

identifer-type

enum<string>

required

Identifier Type. Value can either be id or variant_id

Allowed values:

idvariant_id

identifer

string

required

Identifier Value, such as Product ID or and sku ID

Example:

1210921

quantity

integer

required

Quantity Value

mode

enum<string> | enum<null>

optional

Mode of quantity update; one of the allowed enum values

Allowed values:

overwriteincrementdecrement

Default:

overwrite

unlimited_quantity

boolean

optional

Option to indicate the product is of unlimited quantity

branch

integer

optional

Branch ID, List of Branches IDs can be found here.

reason_id

integer

optional

Reason ID for the update

{
  "products": [
    {
      "identifer_type": "id",
      "identifer": "613398835",
      "quantity": 60,
      "mode": "increment",
      "branch": "349994915",
      "reason_id": 566146469,
      "unlimited_quantity": true
    },
    {
      "identifer_type": "id",
      "identifer": "9834759404",
      "quantity": 80,
      "mode": "overwrite",
      "branch": "349994915",
      "reason_id": 566146469,
      "unlimited_quantity": true
    },
    {
      "identifer_type": "variant_id",
      "identifer": "3498732894",
      "quantity": 14,
      "mode": "decrement",
      "branch": "349994915",
      "reason_id": 566146469
    },
    {
      "identifer_type": "variant_id",
      "identifer": "8439405958",
      "quantity": 140,
      "branch": "349994915",
      "reason_id": 566146469
    }
  ]
}

Request samples

[api.label.responses]

Created(201)

Error Validation(422)

unauthorized(401)

HTTP Code: 201

Content Type : JSONapplication/json

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

object

optional

message

string

optional

A text or data communication generated by a system or application in response to a request.

code

number

optional

A numerical or alphanumeric identifier used in various systems and protocols to indicate the status or outcome of a specific request.

{
  "status": 201,
  "success": true,
  "data": {
    "message": "The details has been queued to update, it may take several minutes to finish the process",
    "code": 201
  }
}

[updatedIn] 2 months ago