Orders V4

List of orders filtered by fulfillment state

Changed on

Retrieve orders sorted by order date from oldest to newest. The number of returned orders is limited to 128; cursor based pagination is supported.

get/v4/orders

Request

  • Base URL
    https://api.otto.market
  • URL
    https://api.otto.market/v4/orders
  • Auth
    HTTP bearer

Query parameters

fromDatestring

Defines earliest change date (ISO 8601) the returned orders should have

fromOrderDatestring

Only orders newer than the date specified (ISO 8601) will be returned

toOrderDatestring

Only orders older than the date specified (ISO 8601) will be returned

fulfillmentStatus'ANNOUNCED' | 'PROCESSABLE' | 'SENT' | 'RETURNED' | 'CANCELLED_BY_PARTNER' | 'CANCELLED_BY_MARKETPLACE'

<br>ANNOUNCED: Orders with at least one position item in state ANNOUNCED<br>PROCESSABLE: Orders with at least one position item in state PROCESSABLE and none in ANNOUNCED<br>SENT: Orders with at least one position item in state SENT and none in either ANNOUNCED or PROCESSABLE<br>RETURNED: Orders with at least one position item in state RETURNED and none in either ANNOUNCED, PROCESSABLE, or SENT<br>CANCELLED_BY_PARTNER: Orders with at least one position item in state CANCELLED_BY_PARTNER<br>CANCELLED_BY_MARKETPLACE: Orders with at least one position item in state CANCELLED_BY_MARKETPLACE<br><br>If no state is provided, orders in all possible states are returned.<br>Several values can be passed; it will return a combination of these states without duplicates.<br>Also see parameter 'mode'.

limitstring

The maximum amount of orders to return. The maximum value is 256

orderDirectionstring

Sort result by 'orderColumnType' in ASCending or DESCending order

orderColumnTypestring

The column on which to apply 'orderDirection' parameter

modestring

In search mode AT_LEAST_ONE orders with at least one position item in given 'fulfillmentStatus' will always be returned

nextcursorstring

Cursor for paging requests. If a next cursor is provided, the only other request parameter being considered is 'limit'<br><br>Note: Only the cursor string is required - not the whole link

Response

Successfully retrieved sales orders

Example response

{
  "links": [
    {
      "href": "/v4/orders/12345678,/v4/orders/?nextCursor=bsdjfvbkjdfv",
      "rel": "next,self,describedby"
    }
  ],
  "resources": [
    {
      "deliveryAddress": {
        "addition": "Hinterm Haus",
        "city": "Musterstadt",
        "countryCode": "DEU",
        "email": "test@example.com",
        "firstName": "Max",
        "houseNumber": "17",
        "lastName": "Mustermann",
        "phoneNumber": "0491234567890",
        "salutation": "MR",
        "street": "Musterstraße",
        "zipCode": "12345"
      },
      "initialDeliveryFees": [
        {
          "deliveryFeeAmount": {
            "amount": 15.99,
            "currency": "EUR"
          },
          "name": "DELIVERY_FEE_STANDARD",
          "positionItemIds": [
            "1cdef481-683c-4a4c-bf42-fa7f6bb00933",
            "09532b32-6f4e-4277-988b-f5f721ca13c4"
          ],
          "vatRate": 19
        }
      ],
      "initialDiscounts": [
        {
          "discountAmount": {
            "amount": 15.99,
            "currency": "EUR"
          },
          "discountId": "9978",
          "discountName": "15% auf Technik",
          "name": "DISCOUNT",
          "positionItemIds": [
            "1cdef481-683c-4a4c-bf42-fa7f6bb00933",
            "09532b32-6f4e-4277-988b-f5f721ca13c4"
          ],
          "vatRate": 19
        }
      ],
      "invoiceAddress": {
        "addition": "Hinterm Haus",
        "city": "Musterstadt",
        "countryCode": "DEU",
        "email": "test@example.com",
        "firstName": "Max",
        "houseNumber": "17",
        "lastName": "Mustermann",
        "phoneNumber": "0491234567890",
        "salutation": "MR",
        "street": "Musterstraße",
        "zipCode": "12345"
      },
      "links": [
        {
          "href": "/v4/orders/12345678,/v4/orders/?nextCursor=bsdjfvbkjdfv",
          "rel": "next,self,describedby"
        }
      ],
      "orderNumber": "p982bht4t29",
      "payment": {
        "paymentMethod": "INVOICE_SINGLE"
      },
      "positionItems": [
        {
          "dealId": "d36cbfd9-b7b9-44d5-96d3-052d6fd97a44",
          "dealName": "Deal der Woche 52",
          "expectedDeliveryDate": "2018-10-30T12:00:00+01:00",
          "itemValueDiscount": {
            "amount": 15.99,
            "currency": "EUR"
          },
          "itemValueGrossPrice": {
            "amount": 15.99,
            "currency": "EUR"
          },
          "itemValueReducedGrossPrice": {
            "amount": 15.99,
            "currency": "EUR"
          },
          "positionItemId": "7323981b-14b4-7123-7812-ac783d98132c",
          "product": {
            "articleNumber": "S000003AXQU",
            "dimensions": [
              {
                "displayName": "Farbe",
                "type": "color",
                "value": "schwarz"
              }
            ],
            "ean": "233232323",
            "productTitle": "Black T-Shirt",
            "sku": "13033",
            "vatRate": 19
          },
          "returnAcceptedByMarketplace": true,
          "trackingInfo": {
            "carrier": "DHL",
            "trackingNumber": "H1234567890123456789"
          }
        }
      ],
      "salesOrderId": "9864623c-42a4-4892-9270-cd733d32362e"
    }
  ]
}

Changes

    • breaking

      for the query request parameter limit, default value 128 was removed

    • breaking

      for the query request parameter mode, default value BUCKET was removed

    • breaking

      for the query request parameter orderColumnType, default value ORDER_LIFECYCLE_DATE was removed

    • breaking

      for the query request parameter orderDirection, default value ASC was removed

    • breaking

      removed the enum value ASC from the query request parameter orderDirection

    • breaking

      removed the enum value AT_LEAST_ONE from the query request parameter mode

    • breaking

      removed the enum value BUCKET from the query request parameter mode

    • breaking

      removed the enum value DESC from the query request parameter orderDirection

    • breaking

      removed the enum value EXPECTED_DELIVERY_DATE from the query request parameter orderColumnType

    • breaking

      removed the enum value LAST_MODIFIED_DATE from the query request parameter orderColumnType

    • breaking

      removed the enum value ORDER_DATE from the query request parameter orderColumnType

    • breaking

      removed the enum value ORDER_LIFECYCLE_DATE from the query request parameter orderColumnType

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      for the query request parameter limit, the type was generalized from integer to string, and format from int32 to no format

    • info

      the response's property default value false was added for the status

    • info

      the response's property default value false was added for the status

    • info

      the response's property default value false was added for the status