PO Number

Body

Media type: application/json

Type: json

Content:

{ "$schema": "", "description": "Generated PO number object", "type": "object", "properties": { "poNumber": { "description": "A human readable generated or manually entered ID assigned to the purchase order", "type": "string", "pattern": "^[a-zA-Z0-9]{1,16}$" } }, "required": [ "poNumber" ], "additionalProperties": false
}

Example:

{ "poNumber" : "100500"
}

HTTP status code 204

Valid PO Number

HTTP status code 400

Bad request, e.g. existing PO Number. Details of the error provided in the response.

Body

Media type: application/json

Type: any

Example:

{ "errors": [ { "message": "may not be null", "type": "1", "code": "-1", "parameters": [ { "key": "moduleTo", "value": "null" } ] } ]
}

HTTP status code 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{ "$schema": "", "id": "errors.schema", "description": "A set of errors", "type": "object", "properties": { "errors": { "description": "List of errors", "id": "errors", "type": "array", "items": { "type": "object", "$schema": "", "id": "error.schema", "description": "An error", "properties": { "message": { "type": "string", "description": "Error message text" }, "type": { "type": "string", "description": "Error message type" }, "code": { "type": "string", "description": "Error message code" }, "parameters": { "description": "Error message parameters", "$schema": "", "id": "parameters.schema", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } } }, "required": [ "message" ] } }, "total_records": { "description": "Total number of errors", "type": "integer" } }
}

Example:

{ "errors": [ { "message": "may not be null", "type": "1", "code": "-1", "parameters": [ { "key": "moduleTo", "value": "null" } ] } ]
}

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: application/json

Type: any

Example:

{ "errors": [ { "message": "may not be null", "type": "1", "code": "-1", "parameters": [ { "key": "moduleTo", "value": "null" } ] } ]
}