Repzo API - Receiving Material (1.0.0)

Download OpenAPI specification:Download

OpenAPI specification for Repzo Receiving Material endpoints.

Find receiving materials

query Parameters

object

Query parameters for filtering receiving materials

Responses

Response samples

200

Content type

application/json

{"data": [{"_id": "string",
"warehouse": "string",
"supplier": "string",
"rep": "string",
"receiptNumber": "string",
"receiptDate": "2019-08-24T14:15:22Z",
"items": [{"product": "string",
"variant": "string",
"expectedQuantity": 0,
"receivedQuantity": 0,
"unitCost": 0,
"totalCost": 0
}
],
"totalAmount": 0,
"status": "pending",
"notes": "string",
"integration_meta": { },
"company_namespace": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
],
"total_result": 0,
"current_count": 0,
"total_pages": 0,
"current_page": 0,
"per_page": 0
}

Create a receiving material

Request Body schema: application/json

warehouse required	string Warehouse ID where materials are received
supplier required	string Supplier ID providing the materials
rep	string Representative ID who received the materials
receiptNumber	string Receipt number
receiptDate	string <date-time> Date when materials were received
required	Array of objects List of items received
notes	string Additional notes
	object Integration metadata

Responses

Request samples

Payload

Content type

application/json

{"warehouse": "string",
"supplier": "string",
"rep": "string",
"receiptNumber": "string",
"receiptDate": "2019-08-24T14:15:22Z",
"items": [{"product": "string",
"variant": "string",
"expectedQuantity": 0,
"receivedQuantity": 0,
"unitCost": 0
}
],
"notes": "string",
"integration_meta": { }
}

Response samples

201

Content type

application/json

{"_id": "string",
"warehouse": "string",
"supplier": "string",
"rep": "string",
"receiptNumber": "string",
"receiptDate": "2019-08-24T14:15:22Z",
"items": [{"product": "string",
"variant": "string",
"expectedQuantity": 0,
"receivedQuantity": 0,
"unitCost": 0,
"totalCost": 0
}
],
"totalAmount": 0,
"status": "pending",
"notes": "string",
"integration_meta": { },
"company_namespace": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Get a receiving material by ID

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"_id": "string",
"warehouse": "string",
"supplier": "string",
"rep": "string",
"receiptNumber": "string",
"receiptDate": "2019-08-24T14:15:22Z",
"items": [{"product": "string",
"variant": "string",
"expectedQuantity": 0,
"receivedQuantity": 0,
"unitCost": 0,
"totalCost": 0
}
],
"totalAmount": 0,
"status": "pending",
"notes": "string",
"integration_meta": { },
"company_namespace": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Update a receiving material

path Parameters

id

required

string

Request Body schema: application/json

receiptDate	string <date-time> Date when materials were received
	Array of objects List of items received
status	string Enum: "pending" "received" "cancelled" Status of the receiving material
notes	string Additional notes
	object Integration metadata

Responses

Request samples

Payload

Content type

application/json

{"receiptDate": "2019-08-24T14:15:22Z",
"items": [{"product": "string",
"variant": "string",
"expectedQuantity": 0,
"receivedQuantity": 0,
"unitCost": 0
}
],
"status": "pending",
"notes": "string",
"integration_meta": { }
}

Response samples

200

Content type

application/json

{"_id": "string",
"warehouse": "string",
"supplier": "string",
"rep": "string",
"receiptNumber": "string",
"receiptDate": "2019-08-24T14:15:22Z",
"items": [{"product": "string",
"variant": "string",
"expectedQuantity": 0,
"receivedQuantity": 0,
"unitCost": 0,
"totalCost": 0
}
],
"totalAmount": 0,
"status": "pending",
"notes": "string",
"integration_meta": { },
"company_namespace": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}