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",
            "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@shop.de",
        "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
addonValues.ccCvv string
addonValues.ccExpires string
addonValues.ccIssue string
addonValues.ccNumber string
addonValues.ccOwner string
addonValues.ccStart string
addonValues.ccType string
addonValues.customerIp string
addonValues.downloadAbandonmentStatus string
addonValues.serviceAbandonmentStatus string
addresses object GXOrderAddressMain
addresses.billing object GXOrderAddress Optional
addresses.billing.additionalAddressInfo string
addresses.billing.b2bStatus boolean
addresses.billing.city string
addresses.billing.company string
addresses.billing.countryId int64
addresses.billing.firstname string
addresses.billing.gender string
addresses.billing.houseNumber string
addresses.billing.lastname string
addresses.billing.postcode string
addresses.billing.street string
addresses.billing.suburb string
addresses.billing.zoneId int64
addresses.customer object GXOrderAddress Optional
addresses.customer.additionalAddressInfo string
addresses.customer.b2bStatus boolean
addresses.customer.city string
addresses.customer.company string
addresses.customer.countryId int64
addresses.customer.firstname string
addresses.customer.gender string
addresses.customer.houseNumber string
addresses.customer.lastname string
addresses.customer.postcode string
addresses.customer.street string
addresses.customer.suburb string
addresses.customer.zoneId int64
addresses.delivery object GXOrderAddress Optional
addresses.delivery.additionalAddressInfo string
addresses.delivery.b2bStatus boolean
addresses.delivery.city string
addresses.delivery.company string
addresses.delivery.countryId int64
addresses.delivery.firstname string
addresses.delivery.gender string
addresses.delivery.houseNumber string
addresses.delivery.lastname string
addresses.delivery.postcode string
addresses.delivery.street string
addresses.delivery.suburb string
addresses.delivery.zoneId int64
comment string
currencyCode string
customer object GXCustomer
customer.email string
customer.id int64 Optional, read only.
customer.number string
customer.phone string
customer.status object GXCustomerStatus
customer.status.discount int64
customer.status.id int64 Optional, read only.
customer.status.image string
customer.status.isGuest boolean
customer.status.name string
customer.vatId int64
id int64 Optional, read only.
items[] array
items[].addonValues object GXOrderItemsAddons
items[].addonValues.productId string
items[].addonValues.productType string
items[].attributes object GXOrderItemAttributes
items[].attributes.combisId int64
items[].attributes.id int64 Optional, read only.
items[].attributes.name string
items[].attributes.optionId int64
items[].attributes.optionValueId int64
items[].attributes.price int64
items[].attributes.priceType string
items[].attributes.value string
items[].checkoutInformation string
items[].discount int64
items[].downloadInformation[] array of string
items[].finalPrice int64
items[].gxCustomizerData[] array of string
items[].id int64 Optional, read only.
items[].isTaxAllowed boolean
items[].model string
items[].name string
items[].price int64
items[].quantity int64
items[].quantityUnitName string
items[].shippingTimeInformation string
items[].tax int64
languageCode string
paymentType object GXPaymentType
paymentType.module string
paymentType.title string
purchaseDate string
shippingType object GXPaymentType
shippingType.module string
shippingType.title string
statusHistory[] array
statusHistory[].comment string
statusHistory[].customerNotified boolean
statusHistory[].dateAdded string
statusHistory[].id int64 Optional, read only.
statusHistory[].statusId int64
statusId int64
totalWeight int64
totals[] array
totals[].class string
totals[].id int64 Optional, read only.
totals[].sortOrder int64
totals[].title string
totals[].value int64
totals[].valueText string