POST api/externals/orders

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
BillNumber	string	None.
TimestampUtc	date	None.
Positions	Collection of BasketPositionRequestDTO	None.

Request Formats

application/json, text/json

Sample:

{
  "BillNumber": "sample string 1",
  "TimestampUtc": "2025-12-11T18:16:45.7236013+00:00",
  "Positions": [
    {
      "PositionId": 1,
      "ProductId": "sample string 2",
      "Amount": 3.0,
      "Name": "sample string 4",
      "OrderTimeUtc": "2025-12-11T18:16:45.7236013+00:00",
      "ProductProps": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    },
    {
      "PositionId": 1,
      "ProductId": "sample string 2",
      "Amount": 3.0,
      "Name": "sample string 4",
      "OrderTimeUtc": "2025-12-11T18:16:45.7236013+00:00",
      "ProductProps": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    }
  ]
}

application/xml, text/xml

Sample:

<BasketRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Qnips.CheckoutAPI.Models">
  <BillNumber>sample string 1</BillNumber>
  <Positions>
    <BasketPositionRequestDTO>
      <Amount>3</Amount>
      <Name>sample string 4</Name>
      <OrderTimeUtc>2025-12-11T18:16:45.7236013+00:00</OrderTimeUtc>
      <PositionId>1</PositionId>
      <ProductId>sample string 2</ProductId>
      <ProductProps>
        <item>
          <key>
            <string xmlns="">sample string 1</string>
          </key>
          <value>
            <string xmlns="">sample string 2</string>
          </value>
        </item>
        <item>
          <key>
            <string xmlns="">sample string 3</string>
          </key>
          <value>
            <string xmlns="">sample string 4</string>
          </value>
        </item>
      </ProductProps>
    </BasketPositionRequestDTO>
    <BasketPositionRequestDTO>
      <Amount>3</Amount>
      <Name>sample string 4</Name>
      <OrderTimeUtc>2025-12-11T18:16:45.7236013+00:00</OrderTimeUtc>
      <PositionId>1</PositionId>
      <ProductId>sample string 2</ProductId>
      <ProductProps>
        <item>
          <key>
            <string xmlns="">sample string 1</string>
          </key>
          <value>
            <string xmlns="">sample string 2</string>
          </value>
        </item>
        <item>
          <key>
            <string xmlns="">sample string 3</string>
          </key>
          <value>
            <string xmlns="">sample string 4</string>
          </value>
        </item>
      </ProductProps>
    </BasketPositionRequestDTO>
  </Positions>
  <TimestampUtc>2025-12-11T18:16:45.7236013+00:00</TimestampUtc>
</BasketRequestDTO>

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 'BasketRequestDTO'.

Response Information

Resource Description

BasketResponseDTO

Name	Type	Additional information
BillNumber	string	None.
TimestampUtc	date	None.
Positions	Collection of BasketPositionResponseDTO	None.
FinalGross	decimal number	None.
FinalVatAmount	decimal number	None.
CurrencyIso	string	None.

Response Formats

application/json, text/json

Sample:

{
  "BillNumber": "sample string 1",
  "TimestampUtc": "2025-12-11T18:16:45.7861003+00:00",
  "Positions": [
    {
      "PositionId": 1,
      "ProductId": "sample string 2",
      "SKU": "sample string 3",
      "GTIN": "sample string 4",
      "Amount": 5.0,
      "Name": "sample string 6",
      "OrderTimeUtc": "2025-12-11T18:16:45.7861003+00:00",
      "ProductProps": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "TotalGross": 8.0,
      "TotalRewards": 9.0,
      "FinalGross": 10.0,
      "FinalVatAmount": 11.0,
      "VatInPercent": 12.0
    },
    {
      "PositionId": 1,
      "ProductId": "sample string 2",
      "SKU": "sample string 3",
      "GTIN": "sample string 4",
      "Amount": 5.0,
      "Name": "sample string 6",
      "OrderTimeUtc": "2025-12-11T18:16:45.7861003+00:00",
      "ProductProps": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "TotalGross": 8.0,
      "TotalRewards": 9.0,
      "FinalGross": 10.0,
      "FinalVatAmount": 11.0,
      "VatInPercent": 12.0
    }
  ],
  "FinalGross": 3.0,
  "FinalVatAmount": 4.0,
  "CurrencyIso": "sample string 5"
}

application/xml, text/xml

Sample:

<BasketResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Qnips.CheckoutAPI.Models">
  <BillNumber>sample string 1</BillNumber>
  <CurrencyIso>sample string 5</CurrencyIso>
  <FinalGross>3</FinalGross>
  <FinalVatAmount>4</FinalVatAmount>
  <Positions>
    <BasketPositionResponseDTO>
      <Amount>5</Amount>
      <FinalGross>10</FinalGross>
      <FinalVatAmount>11</FinalVatAmount>
      <GTIN>sample string 4</GTIN>
      <Name>sample string 6</Name>
      <OrderTimeUtc>2025-12-11T18:16:45.7861003+00:00</OrderTimeUtc>
      <PositionId>1</PositionId>
      <ProductId>sample string 2</ProductId>
      <ProductProps xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </ProductProps>
      <SKU>sample string 3</SKU>
      <TotalGross>8</TotalGross>
      <TotalRewards>9</TotalRewards>
      <VatInPercent>12</VatInPercent>
    </BasketPositionResponseDTO>
    <BasketPositionResponseDTO>
      <Amount>5</Amount>
      <FinalGross>10</FinalGross>
      <FinalVatAmount>11</FinalVatAmount>
      <GTIN>sample string 4</GTIN>
      <Name>sample string 6</Name>
      <OrderTimeUtc>2025-12-11T18:16:45.7861003+00:00</OrderTimeUtc>
      <PositionId>1</PositionId>
      <ProductId>sample string 2</ProductId>
      <ProductProps xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </ProductProps>
      <SKU>sample string 3</SKU>
      <TotalGross>8</TotalGross>
      <TotalRewards>9</TotalRewards>
      <VatInPercent>12</VatInPercent>
    </BasketPositionResponseDTO>
  </Positions>
  <TimestampUtc>2025-12-11T18:16:45.7861003+00:00</TimestampUtc>
</BasketResponseDTO>