GXOrder resource

Methods

  • post - Create Order
  • get - Get Order (Single)
  • put - Update Order

Properties

{
    "addonValues": {
        "ccCvv": "string",
        "ccExpires": "string",
        "ccIssue": "string",
        "ccNumber": "string",
        "ccOwner": "string",
        "ccStart": "string",
        "ccType": "string",
        "customerIp": "string",
        "downloadAbandonmentStatus": "string",
        "serviceAbandonmentStatus": "string"
    },
    "addresses": {
        "billing": {
            "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"
        },
        "customer": {
            "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"
        },
        "delivery": {
            "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": "string",
    "currencyCode": "string",
    "customer": {
        "email": "string",
        "id": "int64",
        "number": "string",
        "phone": "string",
        "status": {
            "discount": "int64",
            "id": "int64",
            "image": "string",
            "isGuest": "boolean",
            "name": "string"
        },
        "vatId": "int64"
    },
    "id": "int64",
    "items": [
        {
            "addonValues": {
                "productId": "string",
                "productType": "string"
            },
            "attributes": {
                "combisId": "int64",
                "id": "int64",
                "name": "string",
                "optionId": "int64",
                "optionValueId": "int64",
                "price": "int64",
                "priceType": "string",
                "value": "string"
            },
            "checkoutInformation": "string",
            "customizationData": {},
            "discount": "int64",
            "downloadInformation": [
                "string"
            ],
            "finalPrice": "int64",
            "gxCustomizerData": [
                "string"
            ],
            "id": "int64",
            "isTaxAllowed": "boolean",
            "model": "string",
            "name": "string",
            "price": "int64",
            "quantity": "int64",
            "quantityUnitName": "string",
            "shippingTimeInformation": "string",
            "tax": "int64"
        }
    ],
    "languageCode": "string",
    "paymentType": {
        "module": "string",
        "title": "string"
    },
    "purchaseDate": "string",
    "shippingType": {
        "module": "string",
        "title": "string"
    },
    "statusHistory": [
        {
            "comment": "string",
            "customerNotified": "boolean",
            "dateAdded": "string",
            "id": "int64",
            "statusId": "int64"
        }
    ],
    "statusId": "int64",
    "totalWeight": "int64",
    "totals": [
        {
            "class": "string",
            "id": "int64",
            "sortOrder": "int64",
            "title": "string",
            "value": "int64",
            "valueText": "string"
        }
    ]
}
{
    "addonValues": {
        "ccCvv": "",
        "ccExpires": "",
        "ccIssue": "",
        "ccNumber": "",
        "ccOwner": "",
        "ccStart": "",
        "ccType": "",
        "customerIp": "",
        "downloadAbandonmentStatus": "0",
        "serviceAbandonmentStatus": "0"
    },
    "addresses": {
        "billing": {
            "additionalAddressInfo": "1. Etage",
            "b2bStatus": false,
            "city": "Bremen",
            "company": "JD Company",
            "countryId": 81,
            "firstname": "John",
            "gender": "m",
            "houseNumber": "123",
            "lastname": "Doe",
            "postcode": "28219",
            "street": "Test Street",
            "suburb": "",
            "zoneId": 0
        },
        "customer": {
            "additionalAddressInfo": "1. Etage",
            "b2bStatus": false,
            "city": "Bremen",
            "company": "JD Company",
            "countryId": 81,
            "firstname": "John",
            "gender": "m",
            "houseNumber": "123",
            "lastname": "Doe",
            "postcode": "28219",
            "street": "Test Street",
            "suburb": "",
            "zoneId": 0
        },
        "delivery": {
            "additionalAddressInfo": "1. Etage",
            "b2bStatus": false,
            "city": "Bremen",
            "company": "JD Company",
            "countryId": 81,
            "firstname": "John",
            "gender": "m",
            "houseNumber": "123",
            "lastname": "Doe",
            "postcode": "28219",
            "street": "Test Street",
            "suburb": "",
            "zoneId": 0
        }
    },
    "comment": "",
    "currencyCode": "EUR",
    "customer": {
        "email": "admin@example.org",
        "id": 1,
        "number": "",
        "phone": "0421 - 22 34 678",
        "status": {
            "discount": 0,
            "id": 0,
            "image": "admin_status.gif",
            "isGuest": false,
            "name": "Admin"
        },
        "vatId": ""
    },
    "items": [
        {
            "addonValues": {
                "productId": 2,
                "quantityUnitId": 1
            },
            "attributes": [
                {
                    "combisId": "null",
                    "id": 1,
                    "name": "Farbe",
                    "optionId": 1,
                    "optionValueId": 1,
                    "price": 0,
                    "priceType": "+",
                    "value": "rot"
                }
            ],
            "checkoutInformation": "Checkout information goes here ...",
            "discount": 0,
            "downloadInformation": [
                {
                    "countAvailable": 14,
                    "filename": "Dokument.pdf",
                    "maxDaysAllowed": 5
                }
            ],
            "finalPrice": 11,
            "id": 1,
            "isTaxAllowed": "true",
            "model": "12345-s-black",
            "name": "Ein Artikel",
            "price": 11,
            "quantity": 1,
            "quantityUnitName": "Liter",
            "shippingTimeInformation": "",
            "tax": 19
        }
    ],
    "languageCode": "DE",
    "paymentType": {
        "module": "cod",
        "title": "cod"
    },
    "purchaseDate": "2015-11-06 12:22:39",
    "shippingType": {
        "module": "flat_flat",
        "title": "Pauschale Versandkosten (Standard)"
    },
    "statusHistory": [
        {
            "comment": "",
            "customerNotified": "true",
            "dateAdded": "2015-11-06 12:22:39",
            "id": 1,
            "statusId": 1
        }
    ],
    "statusId": 1,
    "totalWeight": 0.123,
    "totals": [
        {
            "class": "ot_subtotal",
            "id": 1,
            "sortOrder": 10,
            "title": "Zwischensumme",
            "value": 50,
            "valueText": "50,00 EUR"
        }
    ]
}
Name Type Description Additional
addonValues object GXOrderAddonValues Required
addonValues.ccCvv string Required
addonValues.ccExpires string Required
addonValues.ccIssue string Required
addonValues.ccNumber string Required
addonValues.ccOwner string Required
addonValues.ccStart string Required
addonValues.ccType string Required
addonValues.customerIp string Required
addonValues.downloadAbandonmentStatus string Required
addonValues.serviceAbandonmentStatus string Required
addresses object GXOrderAddressMain Required
addresses.billing object GXOrderAddress Optional
addresses.billing.additionalAddressInfo string Required
addresses.billing.b2bStatus boolean Required
addresses.billing.city string Required
addresses.billing.postcode string Required
addresses.billing.company string Required
addresses.billing.countryId int64 Required
addresses.billing.firstname string Required
addresses.billing.gender string Required
addresses.billing.houseNumber string Required
addresses.billing.lastname string Required
addresses.billing.street string Required
addresses.billing.suburb string Required
addresses.billing.zoneId int64 Required
addresses.customer object GXOrderAddress Optional
addresses.customer.additionalAddressInfo string Required
addresses.customer.b2bStatus boolean Required
addresses.customer.city string Required
addresses.customer.postcode string Required
addresses.customer.company string Required
addresses.customer.countryId int64 Required
addresses.customer.firstname string Required
addresses.customer.gender string Required
addresses.customer.houseNumber string Required
addresses.customer.lastname string Required
addresses.customer.street string Required
addresses.customer.suburb string Required
addresses.customer.zoneId int64 Required
addresses.delivery object GXOrderAddress Optional
addresses.delivery.additionalAddressInfo string Required
addresses.delivery.b2bStatus boolean Required
addresses.delivery.city string Required
addresses.delivery.postcode string Required
addresses.delivery.company string Required
addresses.delivery.countryId int64 Required
addresses.delivery.firstname string Required
addresses.delivery.gender string Required
addresses.delivery.houseNumber string Required
addresses.delivery.lastname string Required
addresses.delivery.street string Required
addresses.delivery.suburb string Required
addresses.delivery.zoneId int64 Required
comment string Required
currencyCode string Required
customer object GXCustomer Required
customer.email string Required
customer.id int64 Optional , read only.
customer.number string Required
customer.phone string Required
customer.status object GXCustomerStatus Required
customer.status.discount int64 Required
customer.status.id int64 Optional , read only.
customer.status.image string Required
customer.status.isGuest boolean Required
customer.status.name string Required
customer.vatId int64 Required
id int64 Optional , read only.
items[] array Required
items[].addonValues object GXOrderItemsAddons Required
items[].addonValues.productId string Required
items[].addonValues.productType string Required
items[].attributes object GXOrderItemAttributes Required
items[].attributes.combisId int64 Required
items[].attributes.id int64 Optional , read only.
items[].attributes.name string Required
items[].attributes.optionId int64 Required
items[].attributes.optionValueId int64 Required
items[].attributes.price int64 Required
items[].attributes.priceType string Required
items[].attributes.value string Required
items[].checkoutInformation string Required
items[].customizationData object Optional
items[].discount int64 Required
items[].downloadInformation[] array of string Required
items[].finalPrice int64 Required
items[].gxCustomizerData[] array of string Required
items[].id int64 Optional , read only.
items[].isTaxAllowed boolean Required
items[].model string Required
items[].name string Required
items[].price int64 Required
items[].quantity int64 Required
items[].quantityUnitName string Required
items[].shippingTimeInformation string Required
items[].tax int64 Required
languageCode string Required
paymentType object GXPaymentType Required
paymentType.module string Required
paymentType.title string Required
purchaseDate string Required
shippingType object GXPaymentType Required
shippingType.module string Required
shippingType.title string Required
statusHistory[] array Required
statusHistory[].comment string Required
statusHistory[].customerNotified boolean Required
statusHistory[].dateAdded string Required
statusHistory[].id int64 Optional , read only.
statusHistory[].statusId int64 Required
statusId int64 Required
totals[] array Required
totals[].class string Required
totals[].id int64 Optional , read only.
totals[].sortOrder int64 Required
totals[].title string Required
totals[].value int64 Required
totals[].valueText string Required
totalWeight int64 Required