Order

Retrieves the collection of Order resources.

Retrieves the collection of Order resources.

SecurityBearer
Request
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
createdAt
string
downloaded
boolean
direction
string
Enum: "outgoing" "incoming"
documentDate[before]
string
documentDate[strictly_before]
string
documentDate[after]
string
documentDate[strictly_after]
string
documentNumber
string
senderName
string
senderName[]
Array of strings
senderId
string
senderId[]
Array of strings
recipientName
string
recipientName[]
Array of strings
recipientId
string
recipientId[]
Array of strings
sortBy[createdAt]
string
Enum: "asc" "desc"
sortBy[documentDate]
string
Enum: "asc" "desc"
sortBy[senderName]
string
Enum: "asc" "desc"
sortBy[recipientName]
string
Enum: "asc" "desc"
Responses
200

Order collection

get/orders
Request samples
Response samples
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Mark the order as downloaded

Mark the order as downloaded. This is useful to keep track of the document that have been received by the user.

SecurityBearer
Request
Request Body schema: application/json
required

The new Order resource

downloaded
required
boolean
uuids
required
Array of strings
Responses
204

Order resource created

400

Invalid input

422

Unprocessable entity

post/orders/downloaded
Request samples
application/json
{
  • "downloaded": true,
  • "uuids": [
    ]
}
Response samples
null

Import a new incoming order in UBL format

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).

SecurityBearer
Request
Request Body schema:
required

The new Order resource

any
Responses
201

Order resource created

400

Invalid input

422

Unprocessable entity

post/orders/incoming/ubl
Request samples
null
Response samples
{
  • "uuid": "string",
  • "direction": "outgoing",
  • "format": "UBL 2.1 XML",
  • "number": "string",
  • "date": "string",
  • "sender": {
    },
  • "recipient": {
    },
  • "createdAt": "string",
  • "downloaded": true,
  • "peppolMessage": {
    },
  • "processType": "order only"
}

Create a new order in UBL format

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.

SecurityBearer
Request
Request Body schema:
required

The new Order resource

any
Responses
201

Order resource created

400

Invalid input

422

Unprocessable entity

post/orders/outgoing/ubl
Request samples
null
Response samples
{
  • "uuid": "string",
  • "direction": "outgoing",
  • "format": "UBL 2.1 XML",
  • "number": "string",
  • "date": "string",
  • "sender": {
    },
  • "recipient": {
    },
  • "createdAt": "string",
  • "downloaded": true,
  • "peppolMessage": {
    },
  • "processType": "order only"
}

Retrieves a Order resource.

Retrieves a Order resource.

SecurityBearer
Request
path Parameters
uuid
required
string

Resource identifier

Responses
200

Order resource

404

Resource not found

get/orders/{uuid}
Request samples
Response samples
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "uuid": "string",
  • "direction": "outgoing",
  • "format": "UBL 2.1 XML",
  • "number": "string",
  • "date": "string",
  • "sender": {
    },
  • "recipient": {
    },
  • "createdAt": "string",
  • "downloaded": true,
  • "peppolMessage": {
    },
  • "processType": "order only"
}

Get the original source document

Retrieves a Order resource.

SecurityBearer
Request
path Parameters
uuid
required
string
Responses
200

Order resource

404

Resource not found

get/orders/{uuid}/source
Request samples
Response samples
No sample