Get list of Orders

GET/v2/orders/

API version

v2

Request method

GET

Operation ID

order-list-orders

---

The list of Orders the User has access to.

Request

Responses

Response-Header

• X-Pagination-Limitinteger

  The limit used to select the resources for the response

• X-Pagination-Skipinteger

  The number of skipped items

• X-Pagination-Pagenumber

  The calculate page of the list response. Refer to parameters to learn more.

• X-Pagination-TotalCountinteger

  The total amount of items available in the remote ressource. Use this value in combination with the limit to calculate the available pages.

Format

application/json

Beschreibung

Schema-Dokumentation

• 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
  ]

Beispiel

Content-Type: application/json

[
  {
    "contractChangeContractId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "customerId": "4317f5c5-1ea8-4084-a9f1-3a8e7e1c94ff",
    "dueDate": "1985-10-26T01:21:00.000Z",
    "invoicingPeriod": 12,
    "items": [
      {
        "addons": [
          {
            "hidden": true,
            "key": "string",
            "value": "string"
          }
        ],
        "articleId": "PS23-PLUS-0004",
        "articleName": "proSpace",
        "articleTemplateName": "Pro-Space-Hosting",
        "attributeConfiguration": [
          {
            "key": "storage",
            "value": "10"
          }
        ],
        "isInclusive": true,
        "orderItemId": "f0f86186-0a5a-45b2-aa33-502777496347",
        "predefinedDomainAggregateId": "aa38d836-fe72-4c43-aad3-9472b51edf61",
        "price": 1000,
        "reference": {
          "contractItemId": "f0f86186-0a5a-45b2-aa33-502777496347",
          "offerItemId": "f0f86186-0a5a-45b2-aa33-502777496347",
          "orderItemId": "f0f86186-0a5a-45b2-aa33-502777496347"
        }
      }
    ],
    "orderDate": "1985-10-26T01:21:00.000Z",
    "orderId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "orderNumber": "5XXXXXX",
    "profile": {
      "email": "email@mittwald.example",
      "firstName": "Ada",
      "lastName": "Lovelace",
      "userId": "f0f86186-0a5a-45b2-aa33-502777496347"
    },
    "status": "NEW",
    "summary": {
      "nonRecurring": 1000,
      "recurring": 9000,
      "summary": 10000
    },
    "type": "NEW_ORDER"
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "contractChangeContractId": {
        "format": "uuid",
        "type": "string"
      },
      "customerId": {
        "example": "4317f5c5-1ea8-4084-a9f1-3a8e7e1c94ff",
        "minLength": 1,
        "type": "string"
      },
      "dueDate": {
        "format": "date-time",
        "type": "string"
      },
      "invoicingPeriod": {
        "description": "Invoicing period in months",
        "example": 12,
        "type": "number"
      },
      "items": {
        "items": {
          "properties": {
            "addons": {
              "items": {
                "properties": {
                  "hidden": {
                    "type": "boolean"
                  },
                  "key": {
                    "type": "string"
                  },
                  "value": {
                    "type": "string"
                  }
                },
                "required": [
                  "key",
                  "value"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "articleId": {
              "example": "PS23-PLUS-0004",
              "type": "string"
            },
            "articleName": {
              "example": "proSpace",
              "type": "string"
            },
            "articleTemplateName": {
              "example": "Pro-Space-Hosting",
              "type": "string"
            },
            "attributeConfiguration": {
              "items": {
                "properties": {
                  "key": {
                    "example": "storage",
                    "type": "string"
                  },
                  "value": {
                    "example": "10",
                    "type": "string"
                  }
                },
                "required": [
                  "key"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "isInclusive": {
              "type": "boolean"
            },
            "orderItemId": {
              "format": "uuid",
              "type": "string"
            },
            "predefinedDomainAggregateId": {
              "example": "aa38d836-fe72-4c43-aad3-9472b51edf61",
              "type": "string"
            },
            "price": {
              "example": 1000,
              "type": "number"
            },
            "reference": {
              "properties": {
                "contractItemId": {
                  "format": "uuid",
                  "type": "string"
                },
                "offerItemId": {
                  "format": "uuid",
                  "type": "string"
                },
                "orderItemId": {
                  "format": "uuid",
                  "type": "string"
                }
              },
              "type": "object"
            }
          },
          "required": [
            "orderItemId",
            "articleId",
            "price",
            "isInclusive"
          ],
          "type": "object"
        },
        "type": "array"
      },
      "orderDate": {
        "format": "date-time",
        "type": "string"
      },
      "orderId": {
        "format": "uuid",
        "type": "string"
      },
      "orderNumber": {
        "example": "5XXXXXX",
        "minLength": 1,
        "type": "string"
      },
      "profile": {
        "properties": {
          "email": {
            "format": "email",
            "type": "string"
          },
          "firstName": {
            "example": "Ada",
            "type": "string"
          },
          "lastName": {
            "example": "Lovelace",
            "type": "string"
          },
          "title": {
            "deprecated": true,
            "description": "the users title",
            "enum": [
              "other",
              "mr",
              "ms"
            ],
            "type": "string"
          },
          "userId": {
            "format": "uuid",
            "type": "string"
          }
        },
        "required": [
          "userId",
          "email"
        ],
        "type": "object"
      },
      "status": {
        "enum": [
          "NEW",
          "CONFIRMED",
          "REJECTED",
          "ABORTED",
          "EXECUTED"
        ],
        "type": "string"
      },
      "summary": {
        "properties": {
          "nonRecurring": {
            "example": 1000,
            "type": "number"
          },
          "recurring": {
            "example": 9000,
            "type": "number"
          },
          "summary": {
            "description": "The total price of the order",
            "example": 10000,
            "type": "number"
          }
        },
        "required": [
          "summary",
          "recurring",
          "nonRecurring"
        ],
        "type": "object"
      },
      "type": {
        "enum": [
          "NEW_ORDER",
          "CONTRACT_CHANGE"
        ],
        "type": "string"
      }
    },
    "required": [
      "orderId",
      "orderNumber",
      "summary",
      "customerId",
      "invoicingPeriod",
      "type",
      "status",
      "items"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

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

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.contract.orderListOrders({
  "queryParameters": {
    "includesStatus": [
      "NEW"
    ],
    "excludesStatus": [
      "NEW"
    ],
    "templateNames": [
      "string"
    ],
    "types": [
      "NEW_ORDER"
    ],
    "limit": 50,
    "page": 1
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Contract\OrderListOrders\OrderListOrdersRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new OrderListOrdersRequest())
  ->withIncludesStatus(["NEW"])
  ->withExcludesStatus(["NEW"])
  ->withTemplateNames(["string"])
  ->withTypes(["NEW_ORDER"])
  ->withLimit(50)
  ->withPage(1);
$response = $client->contract()->orderListOrders($request);

var_dump($response->getBody();