v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Sales Order

View sales order

Returns details of a sales order

get/api/v1/salesOrders/{id}

Path parameters

idstring required

Resource identifier.

Example:17

The resource's identifier.

Response

Operation completed successfully.

Example response

{
  "data": {
    "id": "1",
    "documentNumber": "SO1",
    "externalOrderNumber": "ES01",
    "transactionNumber": "transaction1",
    "customerOrderNumber": "customerOrder1",
    "externalOrderId": "10",
    "salesChannel": {
      "id": "1"
    },
    "bodyIntroduction": "intro",
    "bodyOutroduction": "outro",
    "internalDesignation": "InternalSO1",
    "date": "2024-01-01",
    "status": "created",
    "customer": {
      "id": "1"
    },
    "comment": "Additional comments",
    "project": {
      "id": "1"
    },
    "language": {
      "iso2": "DE"
    },
    "log": {
      "createdAt": "2023-12-01T00:00:00Z",
      "createdBy": {
        "id": "1",
        "name": "User 1",
        "email": "user1@example.com"
      }
    },
    "financials": {
      "paymentMethod": {
        "id": "3"
      },
      "currency": "EUR",
      "costCenter": {
        "id": "1",
        "number": "1234"
      }
    },
    "delivery": {
      "autoShipping": true,
      "fastLane": true,
      "shippingMethod": {
        "id": "1"
      },
      "shippingCosts": [
        {
          "id": "1",
          "quantity": 3,
          "shippingCostProduct": {
            "id": "1"
          }
        }
      ],
      "preferredWarehouse": {
        "id": "2"
      },
      "storageCountry": "DE",
      "email": "user.email@email.org",
      "conditions": "none"
    },
    "tags": [
      {
        "id": "1"
      }
    ],
    "netSales": {
      "amount": "620.00",
      "currency": "EUR"
    },
    "total": {
      "amount": "737.80",
      "currency": "EUR"
    },
    "positions": [
      {
        "id": "1402",
        "sort": 12,
        "hasChildren": false,
        "parent": null,
        "product": {
          "id": "1"
        },
        "quantity": 5
      }
    ]
  }
}