GXOrderListItem resource

Methods

  • get - Get Orders (Multiple)
  • post - Search Orders

Properties

{
    "billingAddress": {
        "additionalAddressInfo": "string",
        "b2bStatus": "boolean",
        "city": "string",
        "company": "string",
        "countryId": "int64",
        "firstname": "string",
        "gender": "string",
        "houseNumber": "string",
        "lastname": "string",
        "postcode": "string",
        "street": "string",
        "suburb": "string",
        "zoneId": "int64"
    },
    "comment": "int64",
    "customerEmail": "string",
    "customerId": "int64",
    "customerMemos": [
        {
            "date": "string",
            "posterId": "int64",
            "text": "string",
            "title": "string"
        }
    ],
    "customerName": "string",
    "customerStatusId": "int64",
    "customerStatusName": "string",
    "deliveryAddress": {
        "additionalAddressInfo": "string",
        "b2bStatus": "boolean",
        "city": "string",
        "company": "string",
        "countryId": "int64",
        "firstname": "string",
        "gender": "string",
        "houseNumber": "string",
        "lastname": "string",
        "postcode": "string",
        "street": "string",
        "suburb": "string",
        "zoneId": "int64"
    },
    "id": "int64",
    "mailStatus": "boolean",
    "paymentType": {
        "module": "string",
        "title": "string"
    },
    "purchaseDate": "int64",
    "shippingType": {
        "module": "string",
        "title": "string"
    },
    "statusId": "int64",
    "statusName": "int64",
    "totalSum": "int64",
    "trackingLinks": [
        "string"
    ],
    "withdrawalIds": [
        "int64"
    ]
}
{
    "billingAddress": {
        "additionalAddressInfo": "",
        "city": "Bremen",
        "company": "",
        "country": "Germany",
        "countryIsoCode": "DE",
        "firstName": "Max",
        "houseNumber": "",
        "lastName": "Mustermann",
        "postcode": "12345",
        "state": "",
        "street": "Testweg 123"
    },
    "comment": "",
    "customerEmail": "test@example.org",
    "customerId": 1,
    "customerMemos": [],
    "customerName": "Max Mustermann",
    "customerStatusId": 0,
    "customerStatusName": "Admin",
    "deliveryAddress": {
        "additionalAddressInfo": "",
        "city": "Bremen",
        "company": "",
        "country": "Germany",
        "countryIsoCode": "DE",
        "firstName": "Max",
        "houseNumber": "",
        "lastName": "Mustermann",
        "postcode": "12345",
        "state": "",
        "street": "Testweg 123"
    },
    "mailStatus": true,
    "paymentType": {
        "module": "MoneyOrder",
        "title": "Rechnung"
    },
    "purchaseDate": "2018-01-01 00:00:00",
    "shippingType": {
        "module": "dp_dp",
        "title": "Deutsche Post (Versand nach DE:  (1 x 2 kg))"
    },
    "statusId": 1,
    "statusName": "Offen",
    "totalSum": "28,70 EUR",
    "trackingLinks": [],
    "withdrawalIds": []
}
Name Type Description Additional
billingAddress object GXOrderAddress Optional
billingAddress.additionalAddressInfo string
billingAddress.b2bStatus boolean
billingAddress.city string
billingAddress.company string
billingAddress.countryId int64
billingAddress.firstname string
billingAddress.gender string
billingAddress.houseNumber string
billingAddress.lastname string
billingAddress.postcode string
billingAddress.street string
billingAddress.suburb string
billingAddress.zoneId int64
comment int64
customerEmail string
customerId int64
customerMemos[] array
customerMemos[].date string
customerMemos[].posterId int64
customerMemos[].text string
customerMemos[].title string
customerName string
customerStatusId int64
customerStatusName string
deliveryAddress object GXOrderAddress
deliveryAddress.additionalAddressInfo string
deliveryAddress.b2bStatus boolean
deliveryAddress.city string
deliveryAddress.company string
deliveryAddress.countryId int64
deliveryAddress.firstname string
deliveryAddress.gender string
deliveryAddress.houseNumber string
deliveryAddress.lastname string
deliveryAddress.postcode string
deliveryAddress.street string
deliveryAddress.suburb string
deliveryAddress.zoneId int64
id int64 Optional, read only.
mailStatus boolean
paymentType object GXPaymentType
paymentType.module string
paymentType.title string
purchaseDate int64
shippingType object GXPaymentType
shippingType.module string
shippingType.title string
statusId int64
statusName int64
totalSum int64
trackingLinks[] array of string
withdrawalIds[] array of int64