POST v1/orders

Backoffice - Salvar pedido novo

Request Information

URI Parameters

None.

Body Parameters

Collection of PostOrderDTO

Name	Type	Additional information
SellerKey	string	None.
Customer	PostCustomerDTO	None.
Status	PostOrderStatus	None.
Number	string	None.
SaleDate	date	None.
CancellationDate	date	None.
Payments	Collection of PaymentDTO	None.
CarrierService	CarrierServiceDTO	None.
Amount	decimal number	None.
FinancialAmount	decimal number	None.
Channel	string	None.
PriceListName	string	None.
TotalAmountCollected	decimal number	None.
Fulfillment	boolean	None.
FulfillmentInvoiceLink	string	None.
Items	Collection of PostOrderItemDTO	None.
Messages	Collection of string	None.
SalesPartners	SalesPartnersDTO	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "SellerKey": "sample string 1",
    "Customer": {
      "Name": "sample string 1",
      "DocumentType": "sample string 2",
      "DocumentNumber": "sample string 3",
      "Email": "sample string 4",
      "PhoneAreaCode": "sample string 5",
      "PhoneNumber": "sample string 6",
      "Gender": 0,
      "BirthDate": "2026-08-10T13:43:26.5544027-03:00",
      "StateInscription": "sample string 8",
      "Address": {
        "Recipient": "sample string 1",
        "Identification": "sample string 2",
        "Street": "sample string 3",
        "Complement": "sample string 4",
        "Number": "sample string 5",
        "ZipCode": "sample string 6",
        "State": "sample string 7",
        "City": "sample string 8",
        "Neighborhood": "sample string 9",
        "Reference": "sample string 10"
      }
    },
    "Status": 0,
    "Number": "sample string 2",
    "SaleDate": "2026-08-10T13:43:26.5544027-03:00",
    "CancellationDate": "2026-08-10T13:43:26.5544027-03:00",
    "Payments": [
      {
        "Description": "sample string 1",
        "Parcels": 2,
        "Value": 3.1,
        "PaymentTransaction": {
          "Date": "2026-08-10T13:43:26.5544027-03:00",
          "CardNumber": "sample string 1",
          "CardName": "sample string 2",
          "DocNsuNumber": "sample string 3",
          "AutorizationCode": "sample string 4",
          "CVV": "sample string 5"
        }
      },
      {
        "Description": "sample string 1",
        "Parcels": 2,
        "Value": 3.1,
        "PaymentTransaction": {
          "Date": "2026-08-10T13:43:26.5544027-03:00",
          "CardNumber": "sample string 1",
          "CardName": "sample string 2",
          "DocNsuNumber": "sample string 3",
          "AutorizationCode": "sample string 4",
          "CVV": "sample string 5"
        }
      }
    ],
    "CarrierService": {
      "Description": "sample string 1",
      "ShippingAmount": 2.1,
      "DeliveryDate": "2026-08-10T13:43:26.5544027-03:00",
      "DateToShip": "2026-08-10T13:43:26.5544027-03:00",
      "Gift": true,
      "GiftMessage": "sample string 5",
      "Transports": [
        {
          "TrackingNumber": "sample string 1",
          "TrackingLink": "sample string 2",
          "InsuranceAmount": 3.1,
          "ExternalCode": "sample string 4",
          "PlpCode": "sample string 5",
          "CarrierName": "sample string 6",
          "Invoice": {
            "AccessKey": "sample string 1",
            "Number": "sample string 2",
            "RegisterDate": "2026-08-10T13:43:26.5544027-03:00",
            "DownloadUrl": "sample string 4"
          }
        },
        {
          "TrackingNumber": "sample string 1",
          "TrackingLink": "sample string 2",
          "InsuranceAmount": 3.1,
          "ExternalCode": "sample string 4",
          "PlpCode": "sample string 5",
          "CarrierName": "sample string 6",
          "Invoice": {
            "AccessKey": "sample string 1",
            "Number": "sample string 2",
            "RegisterDate": "2026-08-10T13:43:26.5544027-03:00",
            "DownloadUrl": "sample string 4"
          }
        }
      ],
      "ShippingAddress": {
        "Recipient": "sample string 1",
        "Identification": "sample string 2",
        "Street": "sample string 3",
        "Complement": "sample string 4",
        "Number": "sample string 5",
        "ZipCode": "sample string 6",
        "State": "sample string 7",
        "City": "sample string 8",
        "Neighborhood": "sample string 9",
        "Reference": "sample string 10"
      }
    },
    "Amount": 4.1,
    "FinancialAmount": 5.1,
    "Channel": "sample string 6",
    "PriceListName": "sample string 7",
    "TotalAmountCollected": 8.1,
    "Fulfillment": true,
    "FulfillmentInvoiceLink": "sample string 9",
    "Items": [
      {
        "SkuCode": "sample string 1",
        "Quantity": 2.1,
        "UnitPrice": 3.1,
        "DiscountAmount": 4.1,
        "FinancialAmount": 5.1,
        "TotalAmount": 6.1,
        "UnitTradedPrice": 7.1
      },
      {
        "SkuCode": "sample string 1",
        "Quantity": 2.1,
        "UnitPrice": 3.1,
        "DiscountAmount": 4.1,
        "FinancialAmount": 5.1,
        "TotalAmount": 6.1,
        "UnitTradedPrice": 7.1
      }
    ],
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "SalesPartners": {
      "SellerPartnerDocument": {},
      "TraderPartnerDocument": {}
    }
  },
  {
    "SellerKey": "sample string 1",
    "Customer": {
      "Name": "sample string 1",
      "DocumentType": "sample string 2",
      "DocumentNumber": "sample string 3",
      "Email": "sample string 4",
      "PhoneAreaCode": "sample string 5",
      "PhoneNumber": "sample string 6",
      "Gender": 0,
      "BirthDate": "2026-08-10T13:43:26.5544027-03:00",
      "StateInscription": "sample string 8",
      "Address": {
        "Recipient": "sample string 1",
        "Identification": "sample string 2",
        "Street": "sample string 3",
        "Complement": "sample string 4",
        "Number": "sample string 5",
        "ZipCode": "sample string 6",
        "State": "sample string 7",
        "City": "sample string 8",
        "Neighborhood": "sample string 9",
        "Reference": "sample string 10"
      }
    },
    "Status": 0,
    "Number": "sample string 2",
    "SaleDate": "2026-08-10T13:43:26.5544027-03:00",
    "CancellationDate": "2026-08-10T13:43:26.5544027-03:00",
    "Payments": [
      {
        "Description": "sample string 1",
        "Parcels": 2,
        "Value": 3.1,
        "PaymentTransaction": {
          "Date": "2026-08-10T13:43:26.5544027-03:00",
          "CardNumber": "sample string 1",
          "CardName": "sample string 2",
          "DocNsuNumber": "sample string 3",
          "AutorizationCode": "sample string 4",
          "CVV": "sample string 5"
        }
      },
      {
        "Description": "sample string 1",
        "Parcels": 2,
        "Value": 3.1,
        "PaymentTransaction": {
          "Date": "2026-08-10T13:43:26.5544027-03:00",
          "CardNumber": "sample string 1",
          "CardName": "sample string 2",
          "DocNsuNumber": "sample string 3",
          "AutorizationCode": "sample string 4",
          "CVV": "sample string 5"
        }
      }
    ],
    "CarrierService": {
      "Description": "sample string 1",
      "ShippingAmount": 2.1,
      "DeliveryDate": "2026-08-10T13:43:26.5544027-03:00",
      "DateToShip": "2026-08-10T13:43:26.5544027-03:00",
      "Gift": true,
      "GiftMessage": "sample string 5",
      "Transports": [
        {
          "TrackingNumber": "sample string 1",
          "TrackingLink": "sample string 2",
          "InsuranceAmount": 3.1,
          "ExternalCode": "sample string 4",
          "PlpCode": "sample string 5",
          "CarrierName": "sample string 6",
          "Invoice": {
            "AccessKey": "sample string 1",
            "Number": "sample string 2",
            "RegisterDate": "2026-08-10T13:43:26.5544027-03:00",
            "DownloadUrl": "sample string 4"
          }
        },
        {
          "TrackingNumber": "sample string 1",
          "TrackingLink": "sample string 2",
          "InsuranceAmount": 3.1,
          "ExternalCode": "sample string 4",
          "PlpCode": "sample string 5",
          "CarrierName": "sample string 6",
          "Invoice": {
            "AccessKey": "sample string 1",
            "Number": "sample string 2",
            "RegisterDate": "2026-08-10T13:43:26.5544027-03:00",
            "DownloadUrl": "sample string 4"
          }
        }
      ],
      "ShippingAddress": {
        "Recipient": "sample string 1",
        "Identification": "sample string 2",
        "Street": "sample string 3",
        "Complement": "sample string 4",
        "Number": "sample string 5",
        "ZipCode": "sample string 6",
        "State": "sample string 7",
        "City": "sample string 8",
        "Neighborhood": "sample string 9",
        "Reference": "sample string 10"
      }
    },
    "Amount": 4.1,
    "FinancialAmount": 5.1,
    "Channel": "sample string 6",
    "PriceListName": "sample string 7",
    "TotalAmountCollected": 8.1,
    "Fulfillment": true,
    "FulfillmentInvoiceLink": "sample string 9",
    "Items": [
      {
        "SkuCode": "sample string 1",
        "Quantity": 2.1,
        "UnitPrice": 3.1,
        "DiscountAmount": 4.1,
        "FinancialAmount": 5.1,
        "TotalAmount": 6.1,
        "UnitTradedPrice": 7.1
      },
      {
        "SkuCode": "sample string 1",
        "Quantity": 2.1,
        "UnitPrice": 3.1,
        "DiscountAmount": 4.1,
        "FinancialAmount": 5.1,
        "TotalAmount": 6.1,
        "UnitTradedPrice": 7.1
      }
    ],
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "SalesPartners": {
      "SellerPartnerDocument": {},
      "TraderPartnerDocument": {}
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfPostOrderDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eXpert.Domain.DTO">
  <PostOrderDTO>
    <Amount>4.1</Amount>
    <CancellationDate>2026-08-10T13:43:26.5544027-03:00</CancellationDate>
    <CarrierService>
      <DateToShip>2026-08-10T13:43:26.5544027-03:00</DateToShip>
      <DeliveryDate>2026-08-10T13:43:26.5544027-03:00</DeliveryDate>
      <Description>sample string 1</Description>
      <Gift>true</Gift>
      <GiftMessage>sample string 5</GiftMessage>
      <ShippingAddress>
        <City>sample string 8</City>
        <Complement>sample string 4</Complement>
        <Identification>sample string 2</Identification>
        <Neighborhood>sample string 9</Neighborhood>
        <Number>sample string 5</Number>
        <Recipient>sample string 1</Recipient>
        <Reference>sample string 10</Reference>
        <State>sample string 7</State>
        <Street>sample string 3</Street>
        <ZipCode>sample string 6</ZipCode>
      </ShippingAddress>
      <ShippingAmount>2.1</ShippingAmount>
      <Transports>
        <TransportDTO>
          <CarrierName>sample string 6</CarrierName>
          <ExternalCode>sample string 4</ExternalCode>
          <InsuranceAmount>3.1</InsuranceAmount>
          <Invoice>
            <AccessKey>sample string 1</AccessKey>
            <DownloadUrl>sample string 4</DownloadUrl>
            <Number>sample string 2</Number>
            <RegisterDate>2026-08-10T13:43:26.5544027-03:00</RegisterDate>
          </Invoice>
          <PlpCode>sample string 5</PlpCode>
          <TrackingLink>sample string 2</TrackingLink>
          <TrackingNumber>sample string 1</TrackingNumber>
        </TransportDTO>
        <TransportDTO>
          <CarrierName>sample string 6</CarrierName>
          <ExternalCode>sample string 4</ExternalCode>
          <InsuranceAmount>3.1</InsuranceAmount>
          <Invoice>
            <AccessKey>sample string 1</AccessKey>
            <DownloadUrl>sample string 4</DownloadUrl>
            <Number>sample string 2</Number>
            <RegisterDate>2026-08-10T13:43:26.5544027-03:00</RegisterDate>
          </Invoice>
          <PlpCode>sample string 5</PlpCode>
          <TrackingLink>sample string 2</TrackingLink>
          <TrackingNumber>sample string 1</TrackingNumber>
        </TransportDTO>
      </Transports>
    </CarrierService>
    <Channel>sample string 6</Channel>
    <Customer>
      <Address>
        <City>sample string 8</City>
        <Complement>sample string 4</Complement>
        <Identification>sample string 2</Identification>
        <Neighborhood>sample string 9</Neighborhood>
        <Number>sample string 5</Number>
        <Recipient>sample string 1</Recipient>
        <Reference>sample string 10</Reference>
        <State>sample string 7</State>
        <Street>sample string 3</Street>
        <ZipCode>sample string 6</ZipCode>
      </Address>
      <BirthDate>2026-08-10T13:43:26.5544027-03:00</BirthDate>
      <DocumentNumber>sample string 3</DocumentNumber>
      <DocumentType>sample string 2</DocumentType>
      <Email>sample string 4</Email>
      <Gender>Female</Gender>
      <Name>sample string 1</Name>
      <PhoneAreaCode>sample string 5</PhoneAreaCode>
      <PhoneNumber>sample string 6</PhoneNumber>
      <StateInscription>sample string 8</StateInscription>
    </Customer>
    <FinancialAmount>5.1</FinancialAmount>
    <Fulfillment>true</Fulfillment>
    <FulfillmentInvoiceLink>sample string 9</FulfillmentInvoiceLink>
    <Items>
      <PostOrderItemDTO>
        <DiscountAmount>4.1</DiscountAmount>
        <FinancialAmount>5.1</FinancialAmount>
        <Quantity>2.1</Quantity>
        <SkuCode>sample string 1</SkuCode>
        <TotalAmount>6.1</TotalAmount>
        <UnitPrice>3.1</UnitPrice>
        <UnitTradedPrice>7.1</UnitTradedPrice>
      </PostOrderItemDTO>
      <PostOrderItemDTO>
        <DiscountAmount>4.1</DiscountAmount>
        <FinancialAmount>5.1</FinancialAmount>
        <Quantity>2.1</Quantity>
        <SkuCode>sample string 1</SkuCode>
        <TotalAmount>6.1</TotalAmount>
        <UnitPrice>3.1</UnitPrice>
        <UnitTradedPrice>7.1</UnitTradedPrice>
      </PostOrderItemDTO>
    </Items>
    <Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Messages>
    <Number>sample string 2</Number>
    <Payments>
      <PaymentDTO>
        <Description>sample string 1</Description>
        <Parcels>2</Parcels>
        <PaymentTransaction>
          <AutorizationCode>sample string 4</AutorizationCode>
          <CVV>sample string 5</CVV>
          <CardName>sample string 2</CardName>
          <CardNumber>sample string 1</CardNumber>
          <Date>2026-08-10T13:43:26.5544027-03:00</Date>
          <DocNsuNumber>sample string 3</DocNsuNumber>
        </PaymentTransaction>
        <Value>3.1</Value>
      </PaymentDTO>
      <PaymentDTO>
        <Description>sample string 1</Description>
        <Parcels>2</Parcels>
        <PaymentTransaction>
          <AutorizationCode>sample string 4</AutorizationCode>
          <CVV>sample string 5</CVV>
          <CardName>sample string 2</CardName>
          <CardNumber>sample string 1</CardNumber>
          <Date>2026-08-10T13:43:26.5544027-03:00</Date>
          <DocNsuNumber>sample string 3</DocNsuNumber>
        </PaymentTransaction>
        <Value>3.1</Value>
      </PaymentDTO>
    </Payments>
    <PriceListName>sample string 7</PriceListName>
    <SaleDate>2026-08-10T13:43:26.5544027-03:00</SaleDate>
    <SalesPartners>
      <SellerPartnerDocument />
      <TraderPartnerDocument />
    </SalesPartners>
    <SellerKey>sample string 1</SellerKey>
    <Status>WaitingForPayment</Status>
    <TotalAmountCollected>8.1</TotalAmountCollected>
  </PostOrderDTO>
  <PostOrderDTO>
    <Amount>4.1</Amount>
    <CancellationDate>2026-08-10T13:43:26.5544027-03:00</CancellationDate>
    <CarrierService>
      <DateToShip>2026-08-10T13:43:26.5544027-03:00</DateToShip>
      <DeliveryDate>2026-08-10T13:43:26.5544027-03:00</DeliveryDate>
      <Description>sample string 1</Description>
      <Gift>true</Gift>
      <GiftMessage>sample string 5</GiftMessage>
      <ShippingAddress>
        <City>sample string 8</City>
        <Complement>sample string 4</Complement>
        <Identification>sample string 2</Identification>
        <Neighborhood>sample string 9</Neighborhood>
        <Number>sample string 5</Number>
        <Recipient>sample string 1</Recipient>
        <Reference>sample string 10</Reference>
        <State>sample string 7</State>
        <Street>sample string 3</Street>
        <ZipCode>sample string 6</ZipCode>
      </ShippingAddress>
      <ShippingAmount>2.1</ShippingAmount>
      <Transports>
        <TransportDTO>
          <CarrierName>sample string 6</CarrierName>
          <ExternalCode>sample string 4</ExternalCode>
          <InsuranceAmount>3.1</InsuranceAmount>
          <Invoice>
            <AccessKey>sample string 1</AccessKey>
            <DownloadUrl>sample string 4</DownloadUrl>
            <Number>sample string 2</Number>
            <RegisterDate>2026-08-10T13:43:26.5544027-03:00</RegisterDate>
          </Invoice>
          <PlpCode>sample string 5</PlpCode>
          <TrackingLink>sample string 2</TrackingLink>
          <TrackingNumber>sample string 1</TrackingNumber>
        </TransportDTO>
        <TransportDTO>
          <CarrierName>sample string 6</CarrierName>
          <ExternalCode>sample string 4</ExternalCode>
          <InsuranceAmount>3.1</InsuranceAmount>
          <Invoice>
            <AccessKey>sample string 1</AccessKey>
            <DownloadUrl>sample string 4</DownloadUrl>
            <Number>sample string 2</Number>
            <RegisterDate>2026-08-10T13:43:26.5544027-03:00</RegisterDate>
          </Invoice>
          <PlpCode>sample string 5</PlpCode>
          <TrackingLink>sample string 2</TrackingLink>
          <TrackingNumber>sample string 1</TrackingNumber>
        </TransportDTO>
      </Transports>
    </CarrierService>
    <Channel>sample string 6</Channel>
    <Customer>
      <Address>
        <City>sample string 8</City>
        <Complement>sample string 4</Complement>
        <Identification>sample string 2</Identification>
        <Neighborhood>sample string 9</Neighborhood>
        <Number>sample string 5</Number>
        <Recipient>sample string 1</Recipient>
        <Reference>sample string 10</Reference>
        <State>sample string 7</State>
        <Street>sample string 3</Street>
        <ZipCode>sample string 6</ZipCode>
      </Address>
      <BirthDate>2026-08-10T13:43:26.5544027-03:00</BirthDate>
      <DocumentNumber>sample string 3</DocumentNumber>
      <DocumentType>sample string 2</DocumentType>
      <Email>sample string 4</Email>
      <Gender>Female</Gender>
      <Name>sample string 1</Name>
      <PhoneAreaCode>sample string 5</PhoneAreaCode>
      <PhoneNumber>sample string 6</PhoneNumber>
      <StateInscription>sample string 8</StateInscription>
    </Customer>
    <FinancialAmount>5.1</FinancialAmount>
    <Fulfillment>true</Fulfillment>
    <FulfillmentInvoiceLink>sample string 9</FulfillmentInvoiceLink>
    <Items>
      <PostOrderItemDTO>
        <DiscountAmount>4.1</DiscountAmount>
        <FinancialAmount>5.1</FinancialAmount>
        <Quantity>2.1</Quantity>
        <SkuCode>sample string 1</SkuCode>
        <TotalAmount>6.1</TotalAmount>
        <UnitPrice>3.1</UnitPrice>
        <UnitTradedPrice>7.1</UnitTradedPrice>
      </PostOrderItemDTO>
      <PostOrderItemDTO>
        <DiscountAmount>4.1</DiscountAmount>
        <FinancialAmount>5.1</FinancialAmount>
        <Quantity>2.1</Quantity>
        <SkuCode>sample string 1</SkuCode>
        <TotalAmount>6.1</TotalAmount>
        <UnitPrice>3.1</UnitPrice>
        <UnitTradedPrice>7.1</UnitTradedPrice>
      </PostOrderItemDTO>
    </Items>
    <Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Messages>
    <Number>sample string 2</Number>
    <Payments>
      <PaymentDTO>
        <Description>sample string 1</Description>
        <Parcels>2</Parcels>
        <PaymentTransaction>
          <AutorizationCode>sample string 4</AutorizationCode>
          <CVV>sample string 5</CVV>
          <CardName>sample string 2</CardName>
          <CardNumber>sample string 1</CardNumber>
          <Date>2026-08-10T13:43:26.5544027-03:00</Date>
          <DocNsuNumber>sample string 3</DocNsuNumber>
        </PaymentTransaction>
        <Value>3.1</Value>
      </PaymentDTO>
      <PaymentDTO>
        <Description>sample string 1</Description>
        <Parcels>2</Parcels>
        <PaymentTransaction>
          <AutorizationCode>sample string 4</AutorizationCode>
          <CVV>sample string 5</CVV>
          <CardName>sample string 2</CardName>
          <CardNumber>sample string 1</CardNumber>
          <Date>2026-08-10T13:43:26.5544027-03:00</Date>
          <DocNsuNumber>sample string 3</DocNsuNumber>
        </PaymentTransaction>
        <Value>3.1</Value>
      </PaymentDTO>
    </Payments>
    <PriceListName>sample string 7</PriceListName>
    <SaleDate>2026-08-10T13:43:26.5544027-03:00</SaleDate>
    <SalesPartners>
      <SellerPartnerDocument />
      <TraderPartnerDocument />
    </SalesPartners>
    <SellerKey>sample string 1</SellerKey>
    <Status>WaitingForPayment</Status>
    <TotalAmountCollected>8.1</TotalAmountCollected>
  </PostOrderDTO>
</ArrayOfPostOrderDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.