Zum Hauptinhalt springen

Get list of Orders of a Customer

GET/customers/{customerId}/orders/
v2
GET
order-list-customer-orders

The list of Orders of a Customer the User has access to, can be filtered by orderStatus, articleTemplate and count.

Request

  • customerIdstring
    required

Responses

application/json
  • Array[
    • *object
      • contractChangeContractIdstring (uuid)
      • customerIdstring (≥ 1 characters)
        required
      • dueDatestring (date-time)
      • invoicingPeriodnumber
        required

        Invoicing period in months

      • itemsarray of object
        required
        • Array[
          • *object
            • addonsarray of object
              • Array[
                • *object
                  • hiddenboolean
                  • keystring
                    required
                  • valuestring
                    required
                ]
            • articleIdstring
              required
            • articleNamestring
            • articleTemplateNamestring
            • attributeConfigurationarray of object
              • Array[
                • *object
                  • keystring
                    required
                  • valuestring
                ]
            • isInclusiveboolean
              required
            • orderItemIdstring (uuid)
              required
            • predefinedDomainAggregateIdstring
            • pricenumber
              required
            • referenceobject
              • contractItemIdstring (uuid)
              • offerItemIdstring (uuid)
              • orderItemIdstring (uuid)
          ]
      • orderDatestring (date-time)
      • orderIdstring (uuid)
        required
      • orderNumberstring (≥ 1 characters)
        required
      • profileobject
        • emailstring (email)
          required
        • firstNamestring
        • lastNamestring
        • titlestring (one of: other, mr, ms)
          deprecated

          the users title

        • userIdstring (uuid)
          required
      • statusstring (one of: NEW, CONFIRMED, REJECTED, ABORTED, EXECUTED)
        required
      • summaryobject
        required
        • nonRecurringnumber
          required
        • recurringnumber
          required
        • summarynumber
          required

          The total price of the order

      • typestring (one of: NEW_ORDER, CONTRACT_CHANGE)
        required
    ]

Usage examples

$ curl \
--fail \
--location \
-H "Authorization: Bearer $MITTWALD_API_TOKEN" \
https://api.mittwald.de/v2/customers/string/orders?limit=50&page=1&includesStatus=NEW&excludesStatus=NEW&templateNames=string