LogoLogo
  • Qvalia Developer Tools
    • API
    • JSON/XML or JSON to XML
    • Attachments to messages
  • Quick Start
  • API Documentation
    • API's
      • Invoice APIs
      • Credit Note APIs
      • Order APIs
      • Order Response APIs
      • Order Change APIs
      • Order Cancellation APIs
      • Catalogue APIs
      • Despatch Advice
      • Enrichment API
      • Partner
  • Sample Data
    • API Sample Data
      • Invoice
      • CreditNote
      • Order
      • OrderResponse
      • OrderChange
      • OrderCancellation
      • Catalogue
      • DespatchAdvice
  • SFTP Integration
    • SFTP Integration
  • VAN Operator
    • Operators
  • Qvalia
    • Home
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. API Documentation
  2. API's

Order Change APIs

PreviousOrder Response APIsNextOrder Cancellation APIs

Was this helpful?

  • GETGet incoming order changes
  • POSTPost incoming order change
  • GETGet incoming read order changes
  • GETGet outgoing order changes
  • POSTPost outgoing order change

Get incoming order changes

get

The change, in JSON, will always include the three latest messages, per default. Using XML you always only get one (as there's no "array" function for XML).

Use limit parameter to change the number of returned messages and combine it with offset to traverse down the list, e.g:

To get new messages only, use the "Get incoming read orderchanges" endpoint instead.

Path parameters
accountRegNoStringOptionalDefault: ""
Query parameters
limitStringOptionalDefault: ""
includeReadStringOptionalDefault: ""
offsetStringOptionalDefault: ""
documentIdStringOptionalDefault: ""
fromStringOptional

YYYY-MM-DD, e.g. 2024-01-01

Default: ""
toStringOptional

YYYY-MM-DD, e.g. 2024-01-01

Default: ""
updatedAtFromStringOptional

YYYY-MM-DD, e.g. 2024-01-01

Default: ""
updatedAtToStringOptional

YYYY-MM-DD, e.g. 2024-01-01

Default: ""
integrationIdStringOptionalDefault: ""
Header parameters
AuthorizationstringOptionalDefault: ""
AcceptStringOptional

Either "application/json" (default) or "application/xml"

Default: ""
Responses
200Success
application/json
204
No content
application/json
400Error
application/json
401Error
application/json
403Error
application/json
404Error
application/json
500Error
application/json
get
GET /transaction/{accountRegNo}/order-changes/incoming HTTP/1.1
Host: api.qvalia.com
Accept: */*
{
  "status": "success",
  "data": [
    {}
  ]
}

Post incoming order change

post

APIs related to order change handing

Order Change is part of Advanced Ordering 3.0:

Message Syntax:

Path parameters
accountRegNoStringOptionalDefault: ""
Header parameters
AuthorizationstringOptionalDefault: ""
Content-TypeStringOptionalDefault: ""
AcceptStringOptional

Either "application/json" (default) or "application/xml"

Default: ""
Body
OrderChangeobjectOptional
Responses
200Success
application/json
400Error
application/json
401Error
application/json
403Error
application/json
404Error
application/json
409Error
application/json
422Error
application/json
500Error
application/json
post
POST /transaction/{accountRegNo}/order-changes/incoming HTTP/1.1
Host: api.qvalia.com
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "OrderChange": {}
}
{
  "status": "success",
  "data": {
    "message": "order response 12335675 sent",
    "order_response_id": "12335675"
  }
}

Get incoming read order changes

get

APIs related to order change handing

Order Change is part of Advanced Ordering 3.0:

Message Syntax:

Path parameters
accountRegNoStringOptionalDefault: ""
Header parameters
AuthorizationstringOptionalDefault: ""
AcceptStringOptional

Either "application/json" (default) or "application/xml"

Default: ""
Responses
200Success
application/json
204
No content
application/json
400Error
application/json
401Error
application/json
403Error
application/json
404Error
application/json
500Error
application/json
get
GET /transaction/{accountRegNo}/order-changes/incoming/readorderchanges HTTP/1.1
Host: api.qvalia.com
Accept: */*
{
  "status": "success",
  "data": [
    {}
  ]
}

Get outgoing order changes

get

The change, in JSON, will always include the three latest messages, per default. Using XML you always only get one (as there's no "array" function for XML).

Use limit parameter to change the number of returned messages and combine it with offset to traverse down the list, e.g:

To get new messages only, use the "Get outgoing read orderchanges" endpoint instead.

Path parameters
accountRegNoStringOptionalDefault: ""
Header parameters
AuthorizationstringOptionalDefault: ""
AcceptStringOptional

Either "application/json" (default) or "application/xml"

Default: ""
Responses
200Success
application/json
204
No content
application/json
400Error
application/json
401Error
application/json
403Error
application/json
404Error
application/json
500Error
application/json
get
GET /transaction/{accountRegNo}/order-changes/outgoing HTTP/1.1
Host: api.qvalia.com
Accept: */*
{
  "status": "success",
  "data": [
    {}
  ]
}

Post outgoing order change

post

APIs related to order change handing

Order Change is part of Advanced Ordering 3.0:

Message Syntax:

Path parameters
accountRegNoStringOptionalDefault: ""
Header parameters
AuthorizationstringOptionalDefault: ""
Content-TypeStringOptionalDefault: ""
AcceptStringOptional

Either "application/json" (default) or "application/xml"

Default: ""
Body
OrderChangeobjectOptional
Responses
200Success
application/json
400Error
application/json
401Error
application/json
403Error
application/json
404Error
application/json
409Error
application/json
422Error
application/json
500Error
application/json
post
POST /transaction/{accountRegNo}/order-changes/outgoing HTTP/1.1
Host: api.qvalia.com
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "OrderChange": {}
}
{
  "status": "success",
  "data": {
    "message": "order response 12335675 sent",
    "order_response_id": "12335675"
  }
}
https://api-qa.qvalia.com/transaction/{accountRegNo}/order-changes/incoming?limit=10&offset=10
https://docs.peppol.eu/poacc/upgrade-3/profiles/65-advanced-ordering/
https://docs.peppol.eu/poacc/upgrade-3/syntax/OrderChange/tree/
https://docs.peppol.eu/poacc/upgrade-3/profiles/65-advanced-ordering/
https://docs.peppol.eu/poacc/upgrade-3/syntax/OrderChange/tree/
https://api-qa.qvalia.com/transaction/{accountRegNo}/order-changes/incoming?limit=10&offset=10
https://docs.peppol.eu/poacc/upgrade-3/profiles/65-advanced-ordering/
https://docs.peppol.eu/poacc/upgrade-3/syntax/OrderChange/tree/