Retrieves the collection of Order resources.
Order collection
{- "hydra:member": [
- {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "uuid": "string",
- "direction": "outgoing",
- "format": "UBL 2.1 XML",
- "number": "string",
- "date": "string",
- "sender": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "name": "string",
- "identifier": "string"
}, - "recipient": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "name": "string",
- "identifier": "string"
}, - "createdAt": "string",
- "downloaded": true,
- "peppolMessage": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "uuid": "string",
- "createdAt": "string",
- "requestSentAt": "string",
- "responseReceivedAt": "string",
- "success": true,
- "errorCode": "string"
}, - "processType": "order only"
}
], - "hydra:totalItems": 0,
- "hydra:view": {
- "@id": "/entity/1",
- "@type": "string",
- "hydra:first": "/entity/1",
- "hydra:last": "/entity/1",
- "hydra:previous": "/entity/1",
- "hydra:next": "/entity/1"
}, - "hydra:search": {
- "@type": "string",
- "hydra:template": "string",
- "hydra:variableRepresentation": "string",
- "hydra:mapping": [
- {
- "@type": "string",
- "variable": "string",
- "property": "string",
- "required": true
}
]
}
}
Mark the order as downloaded. This is useful to keep track of the document that have been received by the user.
Order resource created
Invalid input
Unprocessable entity
{- "downloaded": true,
- "uuids": [
- "string"
]
}
null
Import a received UBL 2.1 order in either the original XML format or the JSON transposition.
You must send the XML or JSON as the request body along with the right Content-Type
header (application/xml
or application/json
).
The new Order resource
Order resource created
Invalid input
Unprocessable entity
null
{- "uuid": "string",
- "direction": "outgoing",
- "format": "UBL 2.1 XML",
- "number": "string",
- "date": "string",
- "sender": {
- "name": "string",
- "identifier": "string"
}, - "recipient": {
- "name": "string",
- "identifier": "string"
}, - "createdAt": "string",
- "downloaded": true,
- "peppolMessage": {
- "uuid": "string",
- "createdAt": "string",
- "requestSentAt": "string",
- "responseReceivedAt": "string",
- "success": true,
- "errorCode": "string"
}, - "processType": "order only"
}
Send a UBL 2.1 order in either the original XML format or the JSON transposition.
You must send the XML or JSON as the request body along with the right Content-Type
header (application/xml
or application/json
).
Optionally you can send the X-Validation-Rule: {validation-rule-code}
where {validation-rule-code}
is one of the available validation rules you can use.
You can retrieve a list of the available validation rules using the API GET /validation-rules
.
By default the validation rule is autodetected using the latest rule available for the given document.
The new Order resource
Order resource created
Invalid input
Unprocessable entity
null
{- "uuid": "string",
- "direction": "outgoing",
- "format": "UBL 2.1 XML",
- "number": "string",
- "date": "string",
- "sender": {
- "name": "string",
- "identifier": "string"
}, - "recipient": {
- "name": "string",
- "identifier": "string"
}, - "createdAt": "string",
- "downloaded": true,
- "peppolMessage": {
- "uuid": "string",
- "createdAt": "string",
- "requestSentAt": "string",
- "responseReceivedAt": "string",
- "success": true,
- "errorCode": "string"
}, - "processType": "order only"
}
Retrieves a Order resource.
Order resource
Resource not found
{- "@context": "string",
- "@id": "string",
- "@type": "string",
- "uuid": "string",
- "direction": "outgoing",
- "format": "UBL 2.1 XML",
- "number": "string",
- "date": "string",
- "sender": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "name": "string",
- "identifier": "string"
}, - "recipient": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "name": "string",
- "identifier": "string"
}, - "createdAt": "string",
- "downloaded": true,
- "peppolMessage": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "uuid": "string",
- "createdAt": "string",
- "requestSentAt": "string",
- "responseReceivedAt": "string",
- "success": true,
- "errorCode": "string"
}, - "processType": "order only"
}