Create Order

post

https://api.sb.moneris.io/onboarding/merchants/{merchant-id}/orders

Submit an order payload to create an order for the merchant

Demandes récentes

Connectez-vous pour voir l'historique complet des demandes

Heure	Statut	Agent utilisateur
Récupération des demandes récentes…

Loading…

Path Params

merchant-id

string

required

length between 13 and 13

Code d’identification de treize caractères.

Body Params

Représente la charge utile pour soumettre une commande.

idempotencyKey

string

required

length between 1 and 36

Identificateur unique requis pour le traitement des demandes idempotentes.

Remarque : Moneris encourage l’utilisation de la version 4 de l’UUID dans les API comme clé d’idempotence.

marketSegment

string | null

enum

Identifies the specific customer or business segment targeted by a product or service.

representativeCode

string | null

Un code qui identifie l'agent représentant associé à la commande.

userDetails

object

required

Un objet contenant des informations personnelles sur l'utilisateur impliqué dans la transaction.

applicablePromotions

array of strings

length ≤ 10

Une liste de codes de promotion applicables à la commande.

applicablePromotions

feeDetails

object | null

Un objet contenant les détails des frais.

applicationDetails

object | null

required

Détails concernant la demande.

agreementModelInformation

object | null

Un objet contenant les détails d'information du modèle d'accord.

valueAddedServices

array of strings

length ≤ 18

Une liste de services à valeur ajoutée associés à la commande.

documentsStatus

object | null

Un objet contenant les détails du statut des documents.

confirmation

object | null

Un objet contenant les détails de la confirmation.

supplies

array of objects

length ≤ 116

Une liste d'articles de fourniture.

supplies

productDetails

object

required

Un objet contenant tous les détails relatifs à un produit.

isAutoAdjudicationRequired

boolean

Un indicateur booléen indiquant si le processus d'adjudication automatique est requis.

isExpeditedOrder

boolean

Un indicateur booléen indiquant si une commande est traitée comme une commande urgente ou accélérée.

cardPlanDetails

object | null

Un objet contenant tous les détails des plans de cartes.

solutions

array of objects

length ≤ 5

Une liste d'éléments de solution.

solutions

deliveryAddress

object | null

a (natural or legal) person that gets addressed

orderCreatedBy

string | null

L'individu responsable de la création de la commande.

Headers

Api-Version

string

required

Defaults to 2025-08-14

Version de l’API du point de terminaison.

Doit être fourni dans la section des en-têtes.

X-Correlation-Id

string

Corrèle une série de requêtes au sein d’un même flux.

Remarque : Cet identifiant est généré par Moneris avec chaque demande ou réponse, s’il n’existe pas.
Les commerçants doivent faire écho à la valeur avec chaque demande qui fait partie du flux d’appels.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201Successful response corresponding to the provided payload

400Mauvaise demande.

401Non autorisé. L’utilisateur ne dispose pas d’une clé API ou d’un jeton d’accès valide.

403Interdit. L’utilisateur n’est pas autorisé à accéder à la ressource demandée.

404Introuvable.

409La demande n’a pas pu être terminée en raison d’un conflit avec l’état de la ressource ou la clé d’idempotence existante.

422L’API ne peut pas effectuer l’action demandée en raison d’erreurs sémantiques ou de validation métier.

429Trop de requêtes

500Erreur inattendue.

503Service temporairement indisponible