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

Catalogue APIs

PreviousOrder Cancellation APIsNextDespatch Advice

Was this helpful?

Get incoming read catalogues

get

APIs related to catalogue handing

Path parameters
accountRegNoStringOptionalDefault: ""
Query parameters
limitStringOptionalDefault: ""
includeReadStringOptionalDefault: ""
offsetStringOptionalDefault: ""
documentIdStringOptionalDefault: ""
fromStringOptionalDefault: ""
toStringOptionalDefault: ""
updatedAtFromStringOptionalDefault: ""
updatedAtToStringOptionalDefault: ""
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}/catalogues/incoming/readCataloguess HTTP/1.1
Host: api.qvalia.com
Accept: */*

{
  "status": "success",
  "data": [
    {}
  ]
}

Get outgoing catalogues

get

Information about Catalogue Endpoints will soon be published in full

Path parameters
accountRegNoStringOptionalDefault: ""
Header parameters
AuthorizationstringRequired

Your Qvalia auth key

Default: ""
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}/catalogues/outgoing HTTP/1.1
Host: api.qvalia.com
Authorization: 
Accept: */*

{
  "status": "success",
  "data": [
    {}
  ]
}
  • GETGet incoming catalogues
  • POSTPost incoming catalogue
  • GETGet incoming read catalogues
  • GETGet outgoing catalogues
  • POSTPost outgoing catalogue

Get incoming catalogues

get

Information about Catalogue Endpoints will soon be published in full

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
AuthorizationstringRequired

Your Qvalia auth key

Default: ""
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}/catalogues/incoming HTTP/1.1
Host: api.qvalia.com
Authorization: 
Accept: */*

{
  "status": "success",
  "data": [
    {}
  ]
}

Post incoming catalogue

post

APIs related to catalogue handing

Path parameters
accountRegNoStringOptionalDefault: ""
Header parameters
AuthorizationstringOptional

Your Qvalia auth key

Default: ""
Content-TypeStringOptionalDefault: ""
AcceptStringOptional

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

Default: ""
Body
CatalogueobjectOptional
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}/catalogues/incoming HTTP/1.1
Host: api.qvalia.com
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "Catalogue": {}
}
{
  "status": "success",
  "data": {
    "message": "catalogue 12335675 sent",
    "catalogue_id": "12335675"
  }
}

Post outgoing catalogue

post

APIs related to catalogue handing

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

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

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

{
  "Catalogue": {}
}
{
  "statusCode": 400,
  "error": "E_INVALID_PARAMETER",
  "message": "Invalid parameters from client"
}