Send a catalogue

post

https://mapi-sandbox.unimaze.com/api/v1/transactions/submit-catalogue

Creates a SubmitCatalogue business transaction from a metadata structure.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Creates a SubmitCatalogue business transaction from a metadata structure.

The more parameter of the call informs the server whether additional document attachments are expected or not and then updates the message status. If no more documents will be added, the call sets the status of the message to received. Otherwise, the message remains open and the message status is notset

Query Params

messageId

uuid

required

The identifier of the message in the format of a valid Universally unique identifier (GUID).

conversationIdentifier

string

The identifier of the conversation.
Used as a correlation identifier between different documents in the same business context, for example, between a credit note that was issued based on an invoice and that invoice.

If not provided, it is generated automatically.
In that case, it includes the date when the message was sent, a random token, and the ISO identifier of the sender.

processingMode

string

enum

The way the transaction is processed.

Allowed:

services

array of strings

A list of services that the user specifies for additional message processing.

services

Body Params

Metadata structure for creating a SubmitCatalogue business transaction.

messageHandling

object

required

Message delivery information.

catalogue

object

required

The metadata structure of a catalogue.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml

200Message validation result

201Message information

422The request was understood but could not be processed.