POST api/orders

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Campaign	string	None.
OrderId	string	None.
TotalPrice	decimal number	None.
ShippingValue	decimal number	None.
BillingAddress	Address	None.
ShippingAddress	Address	None.
Customer	Customer	None.
Products	Collection of Product	None.
Payment	Payment	None.

Request Formats

application/json, text/json

Sample:

{
  "Campaign": "sample string 1",
  "OrderId": "sample string 2",
  "TotalPrice": 3.0,
  "ShippingValue": 4.0,
  "BillingAddress": {
    "Country": "sample string 1",
    "City": "sample string 2",
    "State": "sample string 3",
    "StreetName": "sample string 4",
    "District": "sample string 5",
    "Complement": "sample string 6",
    "Number": "sample string 7",
    "PostalCode": "sample string 8",
    "Reference": "sample string 9",
    "Description": "sample string 10"
  },
  "ShippingAddress": {
    "Country": "sample string 1",
    "City": "sample string 2",
    "State": "sample string 3",
    "StreetName": "sample string 4",
    "District": "sample string 5",
    "Complement": "sample string 6",
    "Number": "sample string 7",
    "PostalCode": "sample string 8",
    "Reference": "sample string 9",
    "Description": "sample string 10"
  },
  "Customer": {
    "Name": "sample string 1",
    "Email": "sample string 2",
    "Document": "sample string 3",
    "BirthDate": "2026-01-15T23:15:34.0132644-06:00",
    "PhoneNumber": "sample string 5"
  },
  "Products": [
    {
      "Sku": "sample string 1",
      "Price": 2.0,
      "Quantity": 3
    },
    {
      "Sku": "sample string 1",
      "Price": 2.0,
      "Quantity": 3
    }
  ],
  "Payment": {
    "CreditCardType": "sample string 1",
    "Quotas": 2,
    "CreditCardNumber": "sample string 3",
    "CreditCardExpirationMonth": 4,
    "CreditCardExpirationYear": 5,
    "CardholderName": "sample string 6",
    "CardholderDocumentNumber": "sample string 7",
    "SecurityCode": "sample string 8"
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OrderResponse

Name	Type	Additional information
SupplierOrderId	string	None.
Status	integer	None.
Message	string	None.
CodeError	string	None.
Exception	string	None.

Response Formats

application/json, text/json

Sample:

{
  "SupplierOrderId": "sample string 1",
  "Status": 2,
  "Message": "sample string 3",
  "CodeError": "sample string 4",
  "Exception": "sample string 5"
}