🔒

Requires write_product access scope. More access scope

The Create Procurement API allows users to create a procurement record associated with a specific supplier. This is useful for managing procurement processes by linking them to suppliers and adding any relevant notes.This API is especially useful for:

1. Recording procurement actions for inventory management.
2. Associating procurement records with specific suppliers.
3. Storing notes or comments about procurement for reference.

Note: The operation is scoped to a specific shop, identified by its unique domain prefix (shopdomain), ensuring all records are tied 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

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 --request POST \
     --url https://{shopdomain}.myshoplazza.com/openapi/2022-01/procurements \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'access-token: <YOUR_ACCESS_TOKEN>' \
     --data '{
         "procurement": {
             "supplier_id": "382453603865993516",
             "note": "Procurement of electronics"
         }
     }'
     }'

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