🔒

Requires write_product access scope. More access scope

The Update Procurement API allows updating the details of an existing procurement record, such as its supplier, note, or other properties. This enables users to modify procurement data efficiently.This API is especially useful for:

1. Updating supplier or notes information for procurement records.
2. Managing and tracking procurement details over time.
3. Reviewing procurement notes and updates for auditing.

Note: The operation is scoped to a specific shop, identified by its unique domain prefix (shopdomain), ensuring all updates are applied to the correct store.

Public Request Parameters

Public Response Parameters

Error and Errors Clarification:

Added explanation that the error and errors fields are currently dependent on the API implementation, with plans for future unification.

Request Parameters

Path Parameters

Body Parameters

Response Explanation

Successful Response

Error Response

Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.

Request Examples

curl -X PUT https://{shopdomain}.myshoplaza.com/openapi/2022-01/procurements/{id} \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
  "procurement": {
    "supplier_id": "382453603865993516",
    "note": "Updated procurement note"
  }
}'

Success Response Example

{
  "procurement": {
    "id": "382451985837728044",
    "procurement_sn": "00000002",
    "supplier_id": "382411381263052204",
    "location_id": "190035786870033452",
    "note": "testaaa",
    "state": 1,
    "pending_quantity": 0,
    "received_quantity": 0,
    "rejected_quantity": 0,
    "transfer_quantity": 0,
    "created_by": "",
    "created_at": "2024-05-21T08:47:39Z",
    "updated_at": "2024-05-21T08:50:36Z"
  }
}
}

Error Response Example

{
  "errors": [
    "Supplier not found"
  ]
}
}

{
  "error": "Supplier not found"}
}

Error Details