POST Supplier/SendOrderDetails

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Order	SendOrderDetailsOrderDTORequest	Required
ParticipantToken	string	Required
Products	Collection of SendOrderDetailsProductDTORequest	None.
Addresses	Collection of SendOrderDetailsAddressDTORequest	None.
Payments	Collection of SendOrderDetailsOrderPaymentDTORequest	None.

Request Formats

application/json, text/json

Sample:

{
  "Products": [
    {
      "ProductID": "sample string 1",
      "ProductSku": "sample string 2",
      "Name": "sample string 3",
      "Quantity": 4,
      "ListPrice": 5.1,
      "SalePrice": 6.1,
      "Discount": 1.1,
      "CostFactor": 1.1,
      "SubSellerExternalCode": "sample string 7",
      "OrderItemDigitalCodes": [
        {
          "DigitalCode": "sample string 1",
          "Description": "sample string 2",
          "ExpirationDate": "2025-04-04T04:53:58.6005319+00:00"
        },
        {
          "DigitalCode": "sample string 1",
          "Description": "sample string 2",
          "ExpirationDate": "2025-04-04T04:53:58.6005319+00:00"
        }
      ],
      "ComplementaryInformationTypeID": 8,
      "ComplementaryInformation": "sample string 9",
      "ProductCategoryID": 1,
      "ProductCategoryName": "sample string 10",
      "RetailPrice": 11.1,
      "FixedFactor": 12.1,
      "PercFactor": 13.1,
      "EmissionFactor": 14.1
    },
    {
      "ProductID": "sample string 1",
      "ProductSku": "sample string 2",
      "Name": "sample string 3",
      "Quantity": 4,
      "ListPrice": 5.1,
      "SalePrice": 6.1,
      "Discount": 1.1,
      "CostFactor": 1.1,
      "SubSellerExternalCode": "sample string 7",
      "OrderItemDigitalCodes": [
        {
          "DigitalCode": "sample string 1",
          "Description": "sample string 2",
          "ExpirationDate": "2025-04-04T04:53:58.6005319+00:00"
        },
        {
          "DigitalCode": "sample string 1",
          "Description": "sample string 2",
          "ExpirationDate": "2025-04-04T04:53:58.6005319+00:00"
        }
      ],
      "ComplementaryInformationTypeID": 8,
      "ComplementaryInformation": "sample string 9",
      "ProductCategoryID": 1,
      "ProductCategoryName": "sample string 10",
      "RetailPrice": 11.1,
      "FixedFactor": 12.1,
      "PercFactor": 13.1,
      "EmissionFactor": 14.1
    }
  ],
  "Addresses": [
    {
      "AddressTypeID": 1,
      "ContactName": "sample string 2",
      "StreetType": "sample string 3",
      "Street": "sample string 4",
      "Number": "sample string 5",
      "Branch": "sample string 6",
      "City": "sample string 7",
      "State": "sample string 8",
      "StateAbbreviation": "sample string 9",
      "ZipCode": "sample string 10",
      "Complement": "sample string 11",
      "ReferencePoint": "sample string 12",
      "PhoneNumber": "sample string 13"
    },
    {
      "AddressTypeID": 1,
      "ContactName": "sample string 2",
      "StreetType": "sample string 3",
      "Street": "sample string 4",
      "Number": "sample string 5",
      "Branch": "sample string 6",
      "City": "sample string 7",
      "State": "sample string 8",
      "StateAbbreviation": "sample string 9",
      "ZipCode": "sample string 10",
      "Complement": "sample string 11",
      "ReferencePoint": "sample string 12",
      "PhoneNumber": "sample string 13"
    }
  ],
  "Payments": [
    {
      "OrderPaymentTypeID": 1,
      "ParcelQuantity": 2,
      "ParcelValue": 3.1,
      "CreditCardNumber": "sample string 4",
      "NSU": "sample string 5",
      "FixedCosts": 6.1,
      "FixedFee": 7.1,
      "AdditionalFee": 8.1
    },
    {
      "OrderPaymentTypeID": 1,
      "ParcelQuantity": 2,
      "ParcelValue": 3.1,
      "CreditCardNumber": "sample string 4",
      "NSU": "sample string 5",
      "FixedCosts": 6.1,
      "FixedFee": 7.1,
      "AdditionalFee": 8.1
    }
  ],
  "Order": {
    "OrderID": 1,
    "ExternalOrderID": "sample string 2",
    "TotalValue": 3.1,
    "TotalDiscountValue": 1.1
  },
  "ParticipantToken": "sample string 1"
}

application/xml, text/xml

Sample:

<SendOrderDetailsDTORequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ParticipantToken>sample string 1</ParticipantToken>
  <Products>
    <SendOrderDetailsProductDTORequest>
      <ProductID>sample string 1</ProductID>
      <ProductSku>sample string 2</ProductSku>
      <Name>sample string 3</Name>
      <Quantity>4</Quantity>
      <ListPrice>5.1</ListPrice>
      <SalePrice>6.1</SalePrice>
      <Discount>1.1</Discount>
      <CostFactor>1.1</CostFactor>
      <SubSellerExternalCode>sample string 7</SubSellerExternalCode>
      <OrderItemDigitalCodes>
        <SendOrderDetailsDigitalCodeDTORequest>
          <DigitalCode>sample string 1</DigitalCode>
          <Description>sample string 2</Description>
          <ExpirationDate>2025-04-04T04:53:58.6005319+00:00</ExpirationDate>
        </SendOrderDetailsDigitalCodeDTORequest>
        <SendOrderDetailsDigitalCodeDTORequest>
          <DigitalCode>sample string 1</DigitalCode>
          <Description>sample string 2</Description>
          <ExpirationDate>2025-04-04T04:53:58.6005319+00:00</ExpirationDate>
        </SendOrderDetailsDigitalCodeDTORequest>
      </OrderItemDigitalCodes>
      <ComplementaryInformationTypeID>8</ComplementaryInformationTypeID>
      <ComplementaryInformation>sample string 9</ComplementaryInformation>
      <ProductCategoryID>1</ProductCategoryID>
      <ProductCategoryName>sample string 10</ProductCategoryName>
      <RetailPrice>11.1</RetailPrice>
      <FixedFactor>12.1</FixedFactor>
      <PercFactor>13.1</PercFactor>
      <EmissionFactor>14.1</EmissionFactor>
    </SendOrderDetailsProductDTORequest>
    <SendOrderDetailsProductDTORequest>
      <ProductID>sample string 1</ProductID>
      <ProductSku>sample string 2</ProductSku>
      <Name>sample string 3</Name>
      <Quantity>4</Quantity>
      <ListPrice>5.1</ListPrice>
      <SalePrice>6.1</SalePrice>
      <Discount>1.1</Discount>
      <CostFactor>1.1</CostFactor>
      <SubSellerExternalCode>sample string 7</SubSellerExternalCode>
      <OrderItemDigitalCodes>
        <SendOrderDetailsDigitalCodeDTORequest>
          <DigitalCode>sample string 1</DigitalCode>
          <Description>sample string 2</Description>
          <ExpirationDate>2025-04-04T04:53:58.6005319+00:00</ExpirationDate>
        </SendOrderDetailsDigitalCodeDTORequest>
        <SendOrderDetailsDigitalCodeDTORequest>
          <DigitalCode>sample string 1</DigitalCode>
          <Description>sample string 2</Description>
          <ExpirationDate>2025-04-04T04:53:58.6005319+00:00</ExpirationDate>
        </SendOrderDetailsDigitalCodeDTORequest>
      </OrderItemDigitalCodes>
      <ComplementaryInformationTypeID>8</ComplementaryInformationTypeID>
      <ComplementaryInformation>sample string 9</ComplementaryInformation>
      <ProductCategoryID>1</ProductCategoryID>
      <ProductCategoryName>sample string 10</ProductCategoryName>
      <RetailPrice>11.1</RetailPrice>
      <FixedFactor>12.1</FixedFactor>
      <PercFactor>13.1</PercFactor>
      <EmissionFactor>14.1</EmissionFactor>
    </SendOrderDetailsProductDTORequest>
  </Products>
  <Addresses>
    <SendOrderDetailsAddressDTORequest>
      <AddressTypeID>1</AddressTypeID>
      <ContactName>sample string 2</ContactName>
      <StreetType>sample string 3</StreetType>
      <Street>sample string 4</Street>
      <Number>sample string 5</Number>
      <Branch>sample string 6</Branch>
      <City>sample string 7</City>
      <State>sample string 8</State>
      <StateAbbreviation>sample string 9</StateAbbreviation>
      <ZipCode>sample string 10</ZipCode>
      <Complement>sample string 11</Complement>
      <ReferencePoint>sample string 12</ReferencePoint>
      <PhoneNumber>sample string 13</PhoneNumber>
    </SendOrderDetailsAddressDTORequest>
    <SendOrderDetailsAddressDTORequest>
      <AddressTypeID>1</AddressTypeID>
      <ContactName>sample string 2</ContactName>
      <StreetType>sample string 3</StreetType>
      <Street>sample string 4</Street>
      <Number>sample string 5</Number>
      <Branch>sample string 6</Branch>
      <City>sample string 7</City>
      <State>sample string 8</State>
      <StateAbbreviation>sample string 9</StateAbbreviation>
      <ZipCode>sample string 10</ZipCode>
      <Complement>sample string 11</Complement>
      <ReferencePoint>sample string 12</ReferencePoint>
      <PhoneNumber>sample string 13</PhoneNumber>
    </SendOrderDetailsAddressDTORequest>
  </Addresses>
  <Payments>
    <SendOrderDetailsOrderPaymentDTORequest>
      <OrderPaymentTypeID>1</OrderPaymentTypeID>
      <ParcelQuantity>2</ParcelQuantity>
      <ParcelValue>3.1</ParcelValue>
      <CreditCardNumber>sample string 4</CreditCardNumber>
      <NSU>sample string 5</NSU>
      <FixedCosts>6.1</FixedCosts>
      <FixedFee>7.1</FixedFee>
      <AdditionalFee>8.1</AdditionalFee>
    </SendOrderDetailsOrderPaymentDTORequest>
    <SendOrderDetailsOrderPaymentDTORequest>
      <OrderPaymentTypeID>1</OrderPaymentTypeID>
      <ParcelQuantity>2</ParcelQuantity>
      <ParcelValue>3.1</ParcelValue>
      <CreditCardNumber>sample string 4</CreditCardNumber>
      <NSU>sample string 5</NSU>
      <FixedCosts>6.1</FixedCosts>
      <FixedFee>7.1</FixedFee>
      <AdditionalFee>8.1</AdditionalFee>
    </SendOrderDetailsOrderPaymentDTORequest>
  </Payments>
  <Order>
    <OrderID>1</OrderID>
    <ExternalOrderID>sample string 2</ExternalOrderID>
    <TotalValue>3.1</TotalValue>
    <TotalDiscountValue>1.1</TotalDiscountValue>
  </Order>
</SendOrderDetailsDTORequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SendOrderDetailsDTORequest'.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.