Order

codestringrequired

order number. Caution! This does not have to be just a number, it can also contain letters, a dash, etc.

Example:"2017000092"

guidstringrequired

global unique permanent order identifier (can be null for old orders)

Example:"c5012051-d7ca-11e0-9a5c-feab5ed617ed"

externalCodestring or nullrequired

Identification of the order in external system (or null). Distinct from internalOrderNumber (the merchant's own custom identifier) and marketplaceExternalOrderId (the order's identifier in a marketplace).

Example:"1234"

internalOrderNumberstring or nullrequired

Custom identifier for this order used for internal accounting or matching, distinct from externalCode, which identifies the order in an external system.

Example:"INT-2026-042"

marketplaceExternalOrderIdstring or nullrequired

Identifier of the order in the marketplace it originated from, distinct from externalCode. Can be null.

Example:"ALG-9988776"

creationTimestring or null(typeDateTimeNullable)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

date and time, when the order was created. ISO 8601 format.

Example:"2018-05-29T09:02:27+0200"

changeTimestring or null(typeDateTimeNullable)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

date and time of the order's last change. ISO 8601 format.

Example:"2018-05-29T09:02:27+0200"

emailstring or nullrequired

purchaser e-mail (can be null)

Example:"customer@someemail.com"

phonestring or nullrequired

purchaser phone number (can be null)

Example:"+420604600444"

birthDatestring or null

customer's date of birth stated in the order

Example:"1980-01-01"

clientIPAddressstring or nullrequired

IP address of the client who made the order

Example:"213.46.237.24"

customerGuidtypeGuidUnlimited (string) or nullrequired

One of:

customer identifier, if the customer is registered in the e-shop (can be null)

<= 36 characters

string(typeGuidUnlimited)

cashDeskOrderbooleanrequired

flag, whether the order is from the cash desk (as opposed to the e-shop)

Example:true

stockIdintegerrequired

identifier of the stock, from which the order was taken

Example:1

addressesEqualbooleanrequired

flag, whether the delivery address is the same as the invoicing address

Example:true

vatPayerbooleanrequired

Is the tradesman a VAT payer, when purchasing? (can be null, if this is unknown)

Example:true

vatModestring or null

VAT mode, for possible values see VAT modes code list

Example:"Normal"

billingMethodbillingMethod (object) or nullrequired

One of:

paymentMethodpaymentMethod (object) or nullrequired

One of:

shippingobject or null(shipping)required

shippingDetailsobject or null

adminUrlstringrequired

URL to administration leading to order detail. URL keeps the administration language settings.

Example:"https://www.domena-eshopu.cz/admin/objednavky-detail?id=2"

statusobject or nullrequired

sourceobject or null

source of the order

salesChannelGuidstring or null, <= 36 characters(typeGuidNullable)^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

sales channel guid

Example:"1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"

priceobject(price)required

price of the order

paidboolean or nullrequired

flag, whether the order was paid. In addition to true a false, can also be null, if the payment status is unknown.

Example:true

billingAddressobject(billingAddress)required

deliveryAddressobject or null(address)required

onlinePaymentLinkstring or null

URL to online payment

Example:"https://www.domena-eshopu.cz/api/pay/payu/redir?paymentCode=xyz123"

languagestring

Language code of the order. Available only if module foreignLanguages is active and initialized.

Example:"cs"

refererstring or null

which page (url) has the user come from

Example:"https://www.google.cz/"

paymentMethodsArray of objects

all order payment methods

shippingsArray of objects

all order shippings

itemsArray of objects(orderItem)required

all order items

notesobject

order notes (only filled in on request if include=notes is listed)

preAuthorizationobject(orderPreAuthorization)

completionArray of objects

All order items completion status. Contains completion info even for product set items.

paymentTransactionsArray of objects

all order payment transactions

{
  "code": "2017000092",
  "guid": "c5012051-d7ca-11e0-9a5c-feab5ed617ed",
  "externalCode": "1234",
  "internalOrderNumber": "INT-2026-042",
  "marketplaceExternalOrderId": "ALG-9988776",
  "creationTime": "2018-05-29T09:02:27+0200",
  "changeTime": "2018-05-29T09:02:27+0200",
  "email": "customer@someemail.com",
  "phone": "+420604600444",
  "birthDate": "1980-01-01",
  "clientIPAddress": "213.46.237.24",
  "customerGuid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
  "cashDeskOrder": true,
  "stockId": 1,
  "addressesEqual": true,
  "vatPayer": true,
  "vatMode": "Normal",
  "billingMethod": {
    "id": 3,
    "name": "Cash"
  },
  "paymentMethod": {
    "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
    "name": "Cash"
  },
  "shipping": {
    "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
    "name": "PPL"
  },
  "shippingDetails": {
    "branchId": "4",
    "shippingCompanyCode": "zasilkovna",
    "shippingServiceCode": "zasilkovna-pickup",
    "name": "Hradec Králové, Square of 5th May 888",
    "note": "<p>Open: Mon-Fri 8:00-18:00, Sat 8:00-12:00</p>",
    "place": "Creator",
    "street": "Square of 5th May 888",
    "city": "Hradec Králové",
    "zipCode": "50002",
    "countryCode": "CZ",
    "link": "https://www.ulozenka.cz/pobocky/4/hradec-kralove-nam-5-kvetna-888",
    "latitude": "50.213673",
    "longitude": "15.832775",
    "carrierId": 3060
  },
  "adminUrl": "https://www.domena-eshopu.cz/admin/objednavky-detail?id=2",
  "status": {
    "name": "Processing",
    "id": -1
  },
  "source": {
    "name": "E-Shop",
    "id": -1
  },
  "salesChannelGuid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
  "price": {
    "vat": "42.00",
    "toPay": "242.00",
    "currencyCode": "CZK",
    "withoutVat": "200.00",
    "withVat": "242.00",
    "exchangeRate": "1.04568087",
    "invoicingExchangeRate": "1.04568087",
    "partialPaymentAmount": "100.00",
    "partialPaymentType": "percents"
  },
  "paid": true,
  "billingAddress": {
    "company": "Shoptet s.r.o.",
    "fullName": "John Doe",
    "street": "French",
    "houseNumber": "123",
    "city": "Praha 2",
    "district": "Praha 2",
    "additional": "4. floor",
    "zip": "120 00",
    "countryCode": "CZ",
    "regionName": "Capital city",
    "regionShortcut": "CC",
    "companyId": "12345678",
    "vatId": "CZ289324675",
    "vatIdValidationStatus": "verified",
    "taxId": "CZ289324675"
  },
  "deliveryAddress": {
    "company": "Shoptet s.r.o.",
    "fullName": "John Doe",
    "street": "French",
    "houseNumber": "123",
    "city": "Praha 2",
    "district": "Praha 2",
    "additional": "4. floor",
    "zip": "120 00",
    "countryCode": "CZ",
    "regionName": "Capital city",
    "regionShortcut": "CC"
  },
  "onlinePaymentLink": "https://www.domena-eshopu.cz/api/pay/payu/redir?paymentCode=xyz123",
  "language": "cs",
  "referer": "https://www.google.cz/",
  "paymentMethods": [
    { … }
  ],
  "shippings": [
    { … }
  ],
  "items": [
    { … }
  ],
  "notes": {
    "customerRemark": "Better in green",
    "eshopRemark": "Gift wrapping",
    "trackingNumber": "DR123456",
    "trackingUrl": "http://www.ppl.cz/main2.aspx?cls=Package&idSearch=DR123456",
    "additionalFields": [ … ]
  },
  "preAuthorization": {
    "hasPendingPreAuthorization": true,
    "preAuthorizationAmount": "21.00"
  },
  "completion": [
    { … }
  ],
  "paymentTransactions": [
    { … }
  ]
}