Create Procurement

🔒

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.

Request Parameters

Public Request Parameters

📘

Public Request Parameters

Body Parameters

ParameterTypeRequiredExampleDescription
procurementobjectYesObject containing procurement details.
procurement.supplier_idstringYes"382453603865993516"ID of the supplier for this procurement.
procurement.notestringNo"Procurement of electronics"Optional note or comment about the procurement.

Response Explanation

Public Response Parameters

📘

Public Response Parameters

Success Response

FieldTypeExampleDescription
procurementobjectObject containing procurement details.
procurement.idstring"928374928374982734"Unique identifier of the procurement record.
procurement.supplier_idstring"382453603865993516"ID of the supplier associated with the procurement.
procurement.notestring"Procurement of electronics"Note or comment added to the procurement.
procurement.created_atstring"2024-05-21T08:56:15Z"Timestamp when the procurement was created.

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.

FieldTypeExampleDescription
errorsArray["Supplier not found"]A list of errors encountered during the request processing.
FieldTypeExampleDescription
errorArray"error": "store is not active"Indicates an error encountered during the process.

Error Details

Status CodeMessageExample ResponsePossible Reason
400Bad RequestBad RequestInvalid input format or request structure (e.g., missing required fields or incorrect data types).
UnauthorizedUnauthorizedThe request is missing valid authentication credentials or the credentials provided are invalid.
422Invalid or empty supplier_id{ "errors": [ "Supplier not found"]}missing required supplier_id or supplier_id with incorrect UUID types

API Structure Overview

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!