Update existing order

PATCH 
/api/v1/order/:orderId

Updates existing order

Request

Path Parameters

orderId stringrequired

id of order to update.

application/json

Body

required

Order data to update.

platform string
name of data source
Example: shopify
orderNumber string
external number of order in eshop
Example: A123456789
externalCreated date-time
optional moment in time when was order created in external system. ISO 8601, format: YYYY-MM-DDThh:mm:ss.sssZ
Example: 2005-08-22T15:01:14Z
externalIdentifier string
optional identifier of order in external system. If provided, must be unique for each order.
Example: ORD123456789

price

object

amount of money in given currency

amount numberrequired

amount of money

Example: 99.96

currency stringrequired

currency of amount in ISO-4217 format

Example: CZK

cashOnDelivery

object

amount of money in given currency

amount numberrequired

amount of money

Example: 99.96

currency stringrequired

currency of amount in ISO-4217 format

Example: CZK

additionalCosts

object[]

Array [

type AdditionalCostType (string)required

Type of additional cost

Possible values: [SHIPPING, CASH_ON_DELIVERY, CARD, BANK_TRANSFER, CASH, PACKING, DUTY, OTHER]

Example: SHIPPING

price

object

required

amount of money in given currency

amount numberrequired

amount of money

Example: 99.96

currency stringrequired

currency of amount in ISO-4217 format

Example: CZK

name string

name of cost

Possible values: Value must match regular expression ^(?!\s*$).+

Example: Home delivery

]

payment

object

Information about payment

paid booleandeprecated

state of payment. if not provided, existing state of payment assigned to order will remain unchanged. DEPRECATION NOTICE: marked for removal, use state instead

Example: false

state PaymentState (string)

State of payment

Possible values: [UNKNOWN, UNPAID, PAID]

Example: PAID

method PaymentMethod (string)

Method used for payment

Possible values: [CASH_ON_DELIVERY, BANK_TRANSFER, CARD, CRYPTO, OTHER]

Example: CASH_ON_DELIVERY

service PaymentService (string)

Type of service used for payment

Possible values: [PAYPAL, APPLE_PAY, GOOGLE_PAY, OTHER]

Example: PAYPAL

link string

payment link. if not provided, existing payment link assigned to order will remain unchanged

Example: https://pay.me

occurred date-time

optional moment in time when was state of payment described by this request set in source system (typically eshop system). if not provided, current time from clock will be used. ISO 8601, format: YYYY-MM-DDThh:mm:ss.sssZ

Example: 2012-12-31T23:59:59.125Z

customer

object

Customer details - name, phone, email

name stringrequired

Customer name

Example: John Doe

email stringrequired

Customer email

Example: iboughtsomething@customer.com

phone stringrequired

Customer phone

Example: +420 123 456 789

destination

object

Destination of order - either house address or parcelShop/box

type DestinationType (string)required

Type of destination

Possible values: [PARCEL_SHOP, PARCEL_BOX, HOUSE_ADDRESS]

Example: HOUSE_ADDRESS

address

object

address details; required data for destination type HOUSE_ADDRESS

line1 stringrequired

address line1

Example: Sesame street

line2 string

address line2

Example: 11b

city stringrequired

city name

Example: MyCoolCity

postalCode stringrequired

zip code

Example: 48228

countryCode CountryCode (string)required

ISO-3166 code of country where ParcelShop/Box is located

Possible values: [UNDEFINED, AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BU, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CP, CR, CS, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, EU, EZ, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NT, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SF, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SU, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UK, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XU, XK, YE, YT, YU, ZA, ZM, ZR, ZW]

Example: US

state string

optional address state

Example: Michigan

region string

optional address region

Example: Michigan

longitude double

GPS longitude

Example: 50.0933864

latitude double

GPS latitude

Example: 14.4542789

parcelShop

object

parcel shop/box details; required data for destination type PARCEL_SHOP|PARCEL_BOX

carrier Carrier (string)required

carrier identifier

Possible values: [BUDBEE, CZECH_POST, DHL, DIY, DPD, DPD_CZ, DPD_PL, DPD_SK, EU_SHIPMENTS, FAN_COURIER, FEDEX, GEBRUDER_WEISS, GEIS, GLS, GLS_CZ, GLS_HR, GLS_HU, GLS_RO, GLS_SI, GLS_SK, GO_BALIK, INPOST, JAPO, KURIER_123, KURYR_123, LANDMARK, MESSENGER, PACKETA, PBH, POST_AG, POCZTA_POLSKA, PPL, PPL_CPL, SAMEDAY, SAMEDAY_RO, SLOVAKIA_POST, SPEEDY, SPRING_GDS, SPS, SWISS_POST, TAXYDROMIKI, TOP_TRANS, ULOZENKA, URGENT_CARGUS, UNKNOWN, UPS, WEDO, PERSONAL_PICKUP]

Example: GLS

countryCode CountryCode (string)required

ISO-3166 code of country where ParcelShop/Box is located

Possible values: [UNDEFINED, AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BU, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CP, CR, CS, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, EU, EZ, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NT, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SF, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SU, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UK, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XU, XK, YE, YT, YU, ZA, ZM, ZR, ZW]

Example: US

parcelShopId stringrequired

identifier of of parcelShop/Box in carrier system

Example: A1234

products

object[]

Array [

type ProductType (string)

Type of product

Possible values: [PRODUCT, DIGITAL_PRODUCT, SERVICE, GIFT, DISCOUNT, VOUCHER]

Example: PRODUCT

sku string

product SKU

Example: A1234

name string

name of product

Example: Awesome product

description string

short product description.

Example: So awesome you must have it!

url string

url of product detail.

Example: https://mycoolshop.com/product/A1234

image string

url of product image.

Example: https://mycoolshop.com/img/product/A1234.png

price

object

amount of money in given currency

amount numberrequired

amount of money

Example: 99.96

currency stringrequired

currency of amount in ISO-4217 format

Example: CZK

vat number

VAT value

Example: 23.5

quantity int32

quantity ordered

Possible values: >= 1

Example: 1

referencedSku string

reference to the SKU of product that this product belongs to, e.g. extended warranty. references product within same order

Example: A9999

]

recommendedProducts

object[]

Array [

type ProductType (string)

Type of product

Possible values: [PRODUCT, DIGITAL_PRODUCT, SERVICE, GIFT, DISCOUNT, VOUCHER]

Example: PRODUCT

sku string

product SKU

Example: A1234

name string

name of product

Example: Awesome product

description string

short product description.

Example: So awesome you must have it!

url string

url of product detail.

Example: https://mycoolshop.com/product/A1234

image string

url of product image.

Example: https://mycoolshop.com/img/product/A1234.png

price

object

amount of money in given currency

amount numberrequired

amount of money

Example: 99.96

currency stringrequired

currency of amount in ISO-4217 format

Example: CZK

]

billingDetails

object

Billing details

name string

Name

Example: John Doe

companyName string

Company name

Example: Doe Ltd

billingAddress

object

address details; required data for destination type HOUSE_ADDRESS

line1 stringrequired

address line1

Example: Sesame street

line2 string

address line2

Example: 11b

city stringrequired

city name

Example: MyCoolCity

postalCode stringrequired

zip code

Example: 48228

countryCode CountryCode (string)required

ISO-3166 code of country where ParcelShop/Box is located

Possible values: [UNDEFINED, AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BU, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CP, CR, CS, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, EU, EZ, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NT, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SF, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SU, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UK, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XU, XK, YE, YT, YU, ZA, ZM, ZR, ZW]

Example: US

state string

optional address state

Example: Michigan

region string

optional address region

Example: Michigan

longitude double

GPS longitude

Example: 50.0933864

latitude double

GPS latitude

Example: 14.4542789

crn string

Company Registration Number

Example: 12345678

vatId string

Value Added Tax Number

Example: CZ12345678

email string

Email address

Example: johndoe@mail.com

phone string

Phone number

Example: +420 123 456 789

externalLinks

object[]

Array [

name string

link name

Example: Invoice

url stringrequired

link url

Example: https://example.com/invoice.pdf

icon ExternalLinkIcon (string)

External Link Icon

Possible values: [LINK, FILE]

Example: FILE

]

communication

object

Customization of communication for given order

orderDetailUrl string

optional url of order in external system; typically order url in eshop. if not explicitly provided in request, existing value remains unchanged.

externalLinks

object[]

Array [

name string

link name

Example: Invoice

url stringrequired

link url

Example: https://example.com/invoice.pdf

icon ExternalLinkIcon (string)

External Link Icon

Possible values: [LINK, FILE]

Example: FILE

]

Responses

200

Order successfully updated.

application/json

Schema

Schema

id uuidrequired

identifier of order

platform string
Name of data source
Example: shopify
orderNumber string
External number of order in eshop
Example: A123456789
orderState OrderState (string)required
State of order
Possible values: [CREATED, PICKING, IN_TRANSIT, PARTIALLY_DELIVERED, DELIVERED, UNDELIVERED, CANCELLED, RETURNED]
Example: IN_TRANSIT
marketId uuidrequired
Id of Market order belongs to
Example: edf4b2ec-c1fc-42da-ba86-eb3a236cd565
eshopId uuidrequired
Id of Eshop order belongs to
Example: edf4b2ec-c1fc-42da-ba86-eb3a236cd565
externalCreated date-time
moment in time when was order created in external system.
Example: 2012-12-31T23:59:59Z
externalIdentifier string
Optional identifier of order in external system
Example: ORD123456789

destination

object

Destination of order - either house address or parcelShop/box

type DestinationType (string)required

Type of destination

Possible values: [PARCEL_SHOP, PARCEL_BOX, HOUSE_ADDRESS]

Example: HOUSE_ADDRESS

address

object

Address details

line1 string

address line1

Example: Sesame street

line2 string

address line2

Example: 11b

city string

Example: MyCoolCity

postalCode string

Example: 48228

countryCode CountryCode (string)

ISO-3166 code of country where ParcelShop/Box is located

Possible values: [UNDEFINED, AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BU, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CP, CR, CS, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, EU, EZ, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NT, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SF, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SU, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UK, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XU, XK, YE, YT, YU, ZA, ZM, ZR, ZW]

Example: US

state string

optional address state

Example: Michigan

region string

optional address region

Example: Michigan

longitude double

GPS longitude

Example: 50.0933864

latitude double

GPS latitude

Example: 14.4542789

parcelShop

object

Details about carriers parcelShop/Box to deliver to

carrier Carrier (string)required

carrier identifier

Possible values: [BUDBEE, CZECH_POST, DHL, DIY, DPD, DPD_CZ, DPD_PL, DPD_SK, EU_SHIPMENTS, FAN_COURIER, FEDEX, GEBRUDER_WEISS, GEIS, GLS, GLS_CZ, GLS_HR, GLS_HU, GLS_RO, GLS_SI, GLS_SK, GO_BALIK, INPOST, JAPO, KURIER_123, KURYR_123, LANDMARK, MESSENGER, PACKETA, PBH, POST_AG, POCZTA_POLSKA, PPL, PPL_CPL, SAMEDAY, SAMEDAY_RO, SLOVAKIA_POST, SPEEDY, SPRING_GDS, SPS, SWISS_POST, TAXYDROMIKI, TOP_TRANS, ULOZENKA, URGENT_CARGUS, UNKNOWN, UPS, WEDO, PERSONAL_PICKUP]

Example: GLS

countryCode CountryCode (string)

ISO-3166 code of country where ParcelShop/Box is located

Possible values: [UNDEFINED, AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BU, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CP, CR, CS, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, EU, EZ, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NT, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SF, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SU, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UK, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XU, XK, YE, YT, YU, ZA, ZM, ZR, ZW]

Example: US

parcelShopId string

Carriers ID of parcelShop/Box

Example: A1234

pickupPlaceId string

businessHours string

price

object

amount of money in given currency

amount numberrequired

amount of money

Example: 99.96

currency stringrequired

currency of amount in ISO-4217 format

Example: CZK

additionalCosts

object[]

required

List of additional costs

Array [

type AdditionalCostType (string)required

Type of additional cost

Possible values: [SHIPPING, CASH_ON_DELIVERY, CARD, BANK_TRANSFER, CASH, PACKING, DUTY, OTHER]

Example: SHIPPING

price

object

required

amount of money in given currency

amount numberrequired

amount of money

Example: 99.96

currency stringrequired

currency of amount in ISO-4217 format

Example: CZK

name string

Name of cost

Possible values: Value must match regular expression ^(?!\s*$).+

Example: Home delivery

]

cashOnDelivery

object

amount of money in given currency

amount numberrequired

amount of money

Example: 99.96

currency stringrequired

currency of amount in ISO-4217 format

Example: CZK

payment

object

Information about payment

paid booleandeprecated

state of payment. DEPRECATION NOTICE: marked for removal, use state instead

Example: false

state PaymentState (string)required

State of payment

Possible values: [UNKNOWN, UNPAID, PAID]

Example: PAID

tag PaymentTag (string)

Optional tag related to UNPAID state of payment

Possible values: [AWAITING_30MIN, AWAITING_1DAY, AWAITING_2DAYS, AWAITING_3DAYS, AWAITING_4DAYS, AWAITING_5DAYS, AWAITING]

Example: AWAITING_30MIN

method PaymentMethod (string)required

Method used for payment

Possible values: [CASH_ON_DELIVERY, BANK_TRANSFER, CARD, CRYPTO, OTHER]

Example: CASH_ON_DELIVERY

service PaymentService (string)required

Type of service used for payment

Possible values: [PAYPAL, APPLE_PAY, GOOGLE_PAY, OTHER]

Example: PAYPAL

link string

payment link

Example: https://pay.me

customer

object

Customer details - name, phone, email

name stringrequired

Customer name

Example: John Doe

email stringrequired

Customer email

Example: iboughtsomething@customer.com

phone stringrequired

Customer phone

Example: +420 123 456 789

parcels

object[]

required

Parcels contained in this order

Array [

id uuidrequired

identifier of parcel

Example: 2b54b81f-1ba6-4196-acc9-894d958bbce7

orderId uuidrequired

id of order this parcel belongs to

Example: 1cad6be8-5bcc-43ff-b9be-a4ed53a2bce1

externalCreated date-time

moment in time when was parcel created in external system.

Example: 2012-12-31T23:59:59Z

dimensions

object

Parcel dimensions

weight double

Package weight in kg

Example: 1.2

height int32

Package height in cm

Example: 25

length int32

Package length in cm

Example: 30

width int32

Package width in cm

Example: 20

deliveryDetails

object

details about order delivery if available

estimatedDeliveryDate date

Date of estimated delivery

Example: 2024-04-18

delay

object

Delivery delay details

delayed boolean

If delivery is delayed

Example: true

reason string

The reason for the delay

Example: The manufacturer is on strike

pin string

optional PIN for pickup

state

object

State of parcel

delivery DeliveryState (string)

state of delivery

Possible values: [CREATED, ESHOP_PROCESSING, MANUFACTURING, AVAILABLE_FROM_MANUFACTURER, PICKING, READY_TO_SEND, HANDED_TO_CARRIER, IN_TRANSIT, STORED_FOR_PICKUP, DELIVERED, RETURNED, LOST, CANCELLED, EXPIRED]

Example: STORED_FOR_PICKUP

important ImportantState (string)deprecated

optional important state assigned to parcel. value is not assigned if parcel is not marked as important

Possible values: [BAD_RATING, MALFUNCTION, TIME_REASONS, ACT_OF_GOD, CARRIERS_FAULT, DAMAGED, NOT_REACHED, DISPOSITION_CHANGE, RETURNING, SLIGHTLY_DELAYED, NOT_PICKED_1DAY, NOT_PICKED_2DAYS, NOT_PICKED_3DAYS]

urgent UrgentState (string)deprecated

optional urgent state assigned to parcel. value is not assigned if parcel is not marked as urgent

Possible values: [REJECTED_FOR_DELIVERY, REJECTED_TAKEOVER, INCORRECT_ADDRESS, OTHER, DELIVERY_DELAYED, NOT_PICKED_4DAYS, NOT_PICKED_5DAYS, LAST_DAY_FOR_PICKUP]

deliverToday boolean

is parcel being delivered today?

returning boolean

is parcel returning back to sender?

trackingState TrackingState (string)

state of parcel tracking

Possible values: [AWAITING, SUSPENDED, TRACKING, MISSING_CREDENTIALS, INVALID_CREDENTIALS, MISSING_CARRIER_CONFIGURATION, INACTIVE_CARRIER_CONFIGURATION, EXPIRED, CANCELLED, MISSING_TRACKING_NUMBER, INVALID_TRACKING_NUMBER, UNKNOWN_TRACKING_NUMBER, DONE]

maxStoreDate date-time

deliveryWindow

object

time window described by two moments in time; beginning and end

from date-time

moment in time when time window starts

to date-time

moment in time when time window ends

activeTracking

object

Tracking of parcel in specific carrier system

trackingId uuidrequired

identifier of this tracking

Example: 2b54b81f-1ba6-4196-acc9-894d958bbce7

carrier Carrier (string)required

carrier identifier

Possible values: [BUDBEE, CZECH_POST, DHL, DIY, DPD, DPD_CZ, DPD_PL, DPD_SK, EU_SHIPMENTS, FAN_COURIER, FEDEX, GEBRUDER_WEISS, GEIS, GLS, GLS_CZ, GLS_HR, GLS_HU, GLS_RO, GLS_SI, GLS_SK, GO_BALIK, INPOST, JAPO, KURIER_123, KURYR_123, LANDMARK, MESSENGER, PACKETA, PBH, POST_AG, POCZTA_POLSKA, PPL, PPL_CPL, SAMEDAY, SAMEDAY_RO, SLOVAKIA_POST, SPEEDY, SPRING_GDS, SPS, SWISS_POST, TAXYDROMIKI, TOP_TRANS, ULOZENKA, URGENT_CARGUS, UNKNOWN, UPS, WEDO, PERSONAL_PICKUP]

Example: GLS

number string

tracking number in carrier system

Example: A1234567890

url string

url of tracking page in carrier system

Example: https://gls-group.eu/CZ/cs/sledovani-zasilek?match=A1234567890

referenceId string

optional id to reference parcel in carrier tracking system

Example: ax72dd

carrierConfigurationId uuid

optional id of carrier configuration in Foxdeli. Carrier configuration is used for communication with carrier api. If no value is provided and carrier requires authorization, primary carrier configuration for given carrier will be used.

courierPhone string

optional phone number of courier that is transporting parcel

timeline

object[]

required

Parcel timeline

Array [

timelineId uuid

Unique id of record

Example: 12345678-1234-1234-1234-1234567890ab

type TimelineType (string)

Type of timeline record

Possible values: [NOTE, COMMUNICATION, ISSUE_COMMUNICATION, TRACKING, ISSUE_TRACKING]

Example: NOTE

text string

Text of record

Example: The client has changed the payment type

created date-time

moment in time when timeline record has been created

Example: 2022-02-16T10:48:11Z

author string

author of record

Example: Malina Red

additionalParams

object

Additional parameters related to timeline record

shippingEmail

object

details about email communication related to timeline records of type COMMUNICATION

recipient string

emailId uuid

emailConfigId uuid

campaignId uuid

state WorkflowState (string)

Possible values: [ACT_OF_GOD, AVAILABLE_FROM_MANUFACTURER, CANCELLED, CARRIERS_FAULT, CROSS_BORDER, DAMAGED, DELIVERED, DELIVERY_DELAYED, DELIVERY_TODAY, DISPOSITION_CHANGED, ESHOP_PROCESSING, ESTIMATED_DELIVERY_DATE, ESTIMATED_DELIVERY_DATE_DELAY, EXPIRED, HANDED_TO_CARRIER, INCORRECT_ADDRESS, IN_TRANSIT, LAST_PICKUP_DAY, LOST, MALFUNCTION, MANUFACTURING, NOT_PICKED_UP_1DAY, NOT_PICKED_UP_2DAYS, NOT_PICKED_UP_3DAYS, NOT_PICKED_UP_4DAYS, NOT_PICKED_UP_5DAYS, NOT_REACHED, ORDER_ACCEPTED, ORDER_CONTENT_CHANGED, ORDER_DESTINATION_CHANGED, ORDER_PAID, ORDER_UNPAID, ORDER_WAITING_FOR_PAYMENT, ORDER_WAITING_FOR_PAYMENT_1DAY, ORDER_WAITING_FOR_PAYMENT_2DAYS, ORDER_WAITING_FOR_PAYMENT_30MIN, ORDER_WAITING_FOR_PAYMENT_3DAYS, ORDER_WAITING_FOR_PAYMENT_4DAYS, ORDER_WAITING_FOR_PAYMENT_5DAYS, OTHER, PICKING, RATING, RATING_1_STAR, RATING_2_STAR, RATING_3_STAR, RATING_4_STAR, RATING_5_STAR, READY_TO_PICKUP, READY_TO_PICKUP_BOX, READY_TO_PICKUP_RETAIL, READY_TO_SEND, REJECTED_DELIVERY, REJECTED_FOR_DELIVERY, RETURNED, RETURNING, SLIGHTLY_DELAYED, TIME_REASONS]

Example: IN_TRANSIT

event EmailEventType (string)

type of event for email communication

Possible values: [EMAIL_SENT, EMAIL_PROCESSED, EMAIL_DROPPED, EMAIL_DELIVERED, EMAIL_DEFERRED, EMAIL_BOUNCED, EMAIL_BLOCKED, EMAIL_OPENED, EMAIL_CLICKED, EMAIL_SPAM_REPORT, EMAIL_UNSUBSCRIBED, EMAIL_GROUP_UNSUBSCRIBED, EMAIL_GROUP_RESUBSCRIBED]

occurred date-time

parcelState

object

descriptor of parcel state that is related to created tracking timeline entry

delivery DeliveryState (string)

state of delivery

Possible values: [CREATED, ESHOP_PROCESSING, MANUFACTURING, AVAILABLE_FROM_MANUFACTURER, PICKING, READY_TO_SEND, HANDED_TO_CARRIER, IN_TRANSIT, STORED_FOR_PICKUP, DELIVERED, RETURNED, LOST, CANCELLED, EXPIRED]

Example: STORED_FOR_PICKUP

important ImportantState (string)deprecated

optional important state assigned to parcel. value is not assigned if parcel is not marked as important

Possible values: [BAD_RATING, MALFUNCTION, TIME_REASONS, ACT_OF_GOD, CARRIERS_FAULT, DAMAGED, NOT_REACHED, DISPOSITION_CHANGE, RETURNING, SLIGHTLY_DELAYED, NOT_PICKED_1DAY, NOT_PICKED_2DAYS, NOT_PICKED_3DAYS]

urgent UrgentState (string)deprecated

optional urgent state assigned to parcel. value is not assigned if parcel is not marked as urgent

Possible values: [REJECTED_FOR_DELIVERY, REJECTED_TAKEOVER, INCORRECT_ADDRESS, OTHER, DELIVERY_DELAYED, NOT_PICKED_4DAYS, NOT_PICKED_5DAYS, LAST_DAY_FOR_PICKUP]

deliverToday boolean

is parcel being delivered today?

returning boolean

is parcel returning back to sender?

parcelStateGroup string

optional group identifier computed from parcel state to determine if two parcel states represent same logical parcel state

parcelTrace

object

deprecated

descriptor of parcel trace that is related to created tracking timeline entry. parcel trace is a container that holds tracking state fields provided by carrier tracking system.

created date-time

moment in time when was this trace created in foxdeli system

occurred date-time

moment in time when tracking event that represents this trace happened in carrier tracking system

carrier Carrier (string)

carrier identifier

Possible values: [BUDBEE, CZECH_POST, DHL, DIY, DPD, DPD_CZ, DPD_PL, DPD_SK, EU_SHIPMENTS, FAN_COURIER, FEDEX, GEBRUDER_WEISS, GEIS, GLS, GLS_CZ, GLS_HR, GLS_HU, GLS_RO, GLS_SI, GLS_SK, GO_BALIK, INPOST, JAPO, KURIER_123, KURYR_123, LANDMARK, MESSENGER, PACKETA, PBH, POST_AG, POCZTA_POLSKA, PPL, PPL_CPL, SAMEDAY, SAMEDAY_RO, SLOVAKIA_POST, SPEEDY, SPRING_GDS, SPS, SWISS_POST, TAXYDROMIKI, TOP_TRANS, ULOZENKA, URGENT_CARGUS, UNKNOWN, UPS, WEDO, PERSONAL_PICKUP]

Example: GLS

trackingNumber string

tracking number of parcel related to tracking event

identifier string

identifier of parcel tracking state in carrier tracking system

text string

optional text containing additional details related to state of parcel

issueTracking

object

details about issue tracking related to timeline records of type ISSUE_TRACKING

type string

externalUrl string

]

products string[]required

Products from order that are contained in this parcel

tags ParcelTag (string)[]required

Optional tags assigned to parcel

Possible values: [TRACKING_SUSPENDED]

carrierTrackingUrl stringdeprecated

Full url to courier's original tracking page. DEPRECATION NOTICE: marked for removal. use activeTracking.url instead.

created date-time

when was parcel created

Example: 2023-09-02T13:05:01.636Z

updated date-time

when was parcel last updated

Example: 2023-09-02T19:55:41.301Z

]

products

object[]

required

Products contained in this order

Array [

type ProductType (string)

Type of product

Possible values: [PRODUCT, DIGITAL_PRODUCT, SERVICE, GIFT, DISCOUNT, VOUCHER]

Example: PRODUCT

sku string

product SKU

Example: A1234

name string

name of product

Example: Awesome product

description string

short product description.

Example: So awesome you must have it!

url string

url of product detail.

Example: https://mycoolshop.com/product/A1234

image string

url of product image.

Example: https://mycoolshop.com/img/product/A1234.png

price

object

amount of money in given currency

amount numberrequired

amount of money

Example: 99.96

currency stringrequired

currency of amount in ISO-4217 format

Example: CZK

vat number

VAT value

Example: 23.5

quantity int32

quantity ordered

Possible values: >= 1

Example: 1

referencedSku string

reference to the SKU of the product it belongs to, e.g. extended warranty. references product within same order

Example: A9999

]

recommendedProducts

object[]

required

Products to be displayed in Recommended Products TnT/email module

Array [

type ProductType (string)

Type of product

Possible values: [PRODUCT, DIGITAL_PRODUCT, SERVICE, GIFT, DISCOUNT, VOUCHER]

Example: PRODUCT

sku string

product SKU

Example: A1234

name string

name of product

Example: Awesome product

description string

short product description.

Example: So awesome you must have it!

url string

url of product detail.

Example: https://mycoolshop.com/product/A1234

image string

url of product image.

Example: https://mycoolshop.com/img/product/A1234.png

price

object

amount of money in given currency

amount numberrequired

amount of money

Example: 99.96

currency stringrequired

currency of amount in ISO-4217 format

Example: CZK

]

cancelled date-timedeprecated

Instant of cancellation. DEPRECATION NOTICE: field is marked for removal and will be removed in one of next major releases

inUrgentState boolean
is order in urgent state?
Example: true
inImportantState boolean
is order in important state?
Example: true
malfunction boolean
is order in malfunction state?
Example: true

snooze

object

Snooze details

until date-time

moment in time until which order is snoozed

Example: 2022-02-16T10:48:11Z

author string

author of snooze

Example: John Doe

note string

snooze note

Example: Resolved

snoozed boolean

is snooze currently active?

Example: false
created date-time
moment in time when was order created
Example: 2023-09-02T13:05:01.636Z
updated date-time
moment in time when was order last updated
Example: 2023-09-02T19:55:41.301Z
invoiceFileUrl string
(Foxdeli storage) URL of the invoice that belongs to this order (optional)
Example: https://storage.url/invoices/11111111-2222-3333-4444-555555555555/123456.pdf
proformaInvoiceFileUrl string
(Foxdeli storage) URL of the proforma invoice that belongs to this order (optional)
Example: https://storage.url/invoices/11111111-2222-3333-4444-555555555555/123456.pdf

files

object[]

required

List of files attached to order

Array [

id string

identifier of file

name string

name of a file

url string

url to access file content

contentType string

content type of file

]

links

object

required

trackAndTrace

object

required

link to a resource

href string

billingDetails

object

Billing details

name string

Name

Example: John Doe

companyName string

Company name

Example: Doe Ltd

billingAddress

object

Address details

line1 string

address line1

Example: Sesame street

line2 string

address line2

Example: 11b

city string

Example: MyCoolCity

postalCode string

Example: 48228

countryCode CountryCode (string)

ISO-3166 code of country where ParcelShop/Box is located

Possible values: [UNDEFINED, AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BU, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CP, CR, CS, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, EU, EZ, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NT, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SF, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SU, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UK, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XU, XK, YE, YT, YU, ZA, ZM, ZR, ZW]

Example: US

state string

optional address state

Example: Michigan

region string

optional address region

Example: Michigan

longitude double

GPS longitude

Example: 50.0933864

latitude double

GPS latitude

Example: 14.4542789

crn string

Company Registration Number

Example: 12345678

vatId string

Value Added Tax Number

Example: CZ12345678

email string

Email address

Example: johndoe@mail.com

phone string

Phone number

Example: +420 123 456 789
language LanguageCode (string)
Order language - two letter language code - ISO-639-1
Possible values: [undefined, aa, ab, ae, af, ak, am, an, ar, as, av, ay, az, ba, be, bg, bh, bi, bm, bn, bo, br, bs, ca, ce, ch, co, cr, cs, cu, cv, cy, da, de, dv, dz, ee, el, en, eo, es, et, eu, fa, ff, fi, fj, fo, fr, fy, ga, gd, gl, gn, gu, gv, ha, he, hi, ho, hr, ht, hu, hy, hz, ia, id, ie, ig, ii, ik, io, is, it, iu, ja, jv, ka, kg, ki, kj, kk, kl, km, kn, ko, kr, ks, ku, kv, kw, ky, la, lb, lg, li, ln, lo, lt, lu, lv, mg, mh, mi, mk, ml, mn, mr, ms, mt, my, na, nb, nd, ne, ng, nl, nn, no, nr, nv, ny, oc, oj, om, or, os, pa, pi, pl, ps, pt, qu, rm, rn, ro, ru, rw, sa, sc, sd, se, sg, si, sk, sl, sm, sn, so, sq, sr, ss, st, su, sv, sw, ta, te, tg, th, ti, tk, tl, tn, to, tr, ts, tt, tw, ty, ug, uk, ur, uz, ve, vi, vo, wa, wo, xh, yi, yo, za, zh, zu]
Example: cs

externalLinks

object[]

deprecated

list of order external links. DEPRECATION NOTICE: marked for removal. use communication.externalLinks instead.

Array [

name string

link name

Example: Invoice

url string

link url

Example: https://example.com/invoice.pdf

icon ExternalLinkIcon (string)

External Link Icon

Possible values: [LINK, FILE]

Example: FILE

]

communication

object

required

Customization of communication for given order

optional url of order in external system; typically order url in eshop string

externalLinks

object[]

Array [

name string

link name

Example: Invoice

url stringrequired

link url

Example: https://example.com/invoice.pdf

icon ExternalLinkIcon (string)

External Link Icon

Possible values: [LINK, FILE]

Example: FILE

]

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "platform": "shopify",
  "orderNumber": "A123456789",
  "orderState": "IN_TRANSIT",
  "marketId": "edf4b2ec-c1fc-42da-ba86-eb3a236cd565",
  "eshopId": "edf4b2ec-c1fc-42da-ba86-eb3a236cd565",
  "externalCreated": "2012-12-31T23:59:59Z",
  "externalIdentifier": "ORD123456789",
  "destination": {
    "type": "HOUSE_ADDRESS",
    "address": {
      "line1": "Sesame street",
      "line2": "11b",
      "city": "MyCoolCity",
      "postalCode": "48228",
      "countryCode": "US",
      "state": "Michigan",
      "region": "Michigan",
      "longitude": 50.0933864,
      "latitude": 14.4542789
    },
    "parcelShop": {
      "carrier": "GLS",
      "countryCode": "US",
      "parcelShopId": "A1234",
      "pickupPlaceId": "string",
      "businessHours": "string"
    }
  },
  "price": {
    "amount": 99.96,
    "currency": "CZK"
  },
  "additionalCosts": [
    {
      "type": "SHIPPING",
      "price": {
        "amount": 99.96,
        "currency": "CZK"
      },
      "name": "Home delivery"
    }
  ],
  "cashOnDelivery": {
    "amount": 99.96,
    "currency": "CZK"
  },
  "payment": {
    "state": "PAID",
    "tag": "AWAITING_30MIN",
    "method": "CASH_ON_DELIVERY",
    "service": "PAYPAL",
    "link": "https://pay.me"
  },
  "customer": {
    "name": "John Doe",
    "email": "iboughtsomething@customer.com",
    "phone": "+420 123 456 789"
  },
  "parcels": [
    {
      "id": "2b54b81f-1ba6-4196-acc9-894d958bbce7",
      "orderId": "1cad6be8-5bcc-43ff-b9be-a4ed53a2bce1",
      "externalCreated": "2012-12-31T23:59:59Z",
      "dimensions": {
        "weight": 1.2,
        "height": 25,
        "length": 30,
        "width": 20
      },
      "deliveryDetails": {
        "estimatedDeliveryDate": "2024-04-18",
        "delay": {
          "delayed": true,
          "reason": "The manufacturer is on strike"
        }
      },
      "pin": "string",
      "state": {
        "delivery": "STORED_FOR_PICKUP",
        "deliverToday": true,
        "returning": true
      },
      "trackingState": "AWAITING",
      "maxStoreDate": "2024-07-29T15:51:28.071Z",
      "deliveryWindow": {
        "from": "2024-07-29T15:51:28.071Z",
        "to": "2024-07-29T15:51:28.071Z"
      },
      "activeTracking": {
        "trackingId": "2b54b81f-1ba6-4196-acc9-894d958bbce7",
        "carrier": "GLS",
        "number": "A1234567890",
        "url": "https://gls-group.eu/CZ/cs/sledovani-zasilek?match=A1234567890",
        "referenceId": "ax72dd",
        "carrierConfigurationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "courierPhone": "string"
      },
      "timeline": [
        {
          "timelineId": "12345678-1234-1234-1234-1234567890ab",
          "type": "NOTE",
          "text": "The client has changed the payment type",
          "created": "2022-02-16T10:48:11Z",
          "author": "Malina Red",
          "additionalParams": {
            "shippingEmail": {
              "recipient": "string",
              "emailId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "emailConfigId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "campaignId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "state": "IN_TRANSIT",
              "event": "EMAIL_SENT",
              "occurred": "2024-07-29T15:51:28.071Z"
            },
            "parcelState": {
              "delivery": "STORED_FOR_PICKUP",
              "deliverToday": true,
              "returning": true
            },
            "parcelStateGroup": "string",
            "issueTracking": {
              "type": "string",
              "externalUrl": "string"
            }
          }
        }
      ],
      "products": [
        "string"
      ],
      "tags": [
        "TRACKING_SUSPENDED"
      ],
      "created": "2023-09-02T13:05:01.636Z",
      "updated": "2023-09-02T19:55:41.301Z"
    }
  ],
  "products": [
    {
      "type": "PRODUCT",
      "sku": "A1234",
      "name": "Awesome product",
      "description": "So awesome you must have it!",
      "url": "https://mycoolshop.com/product/A1234",
      "image": "https://mycoolshop.com/img/product/A1234.png",
      "price": {
        "amount": 99.96,
        "currency": "CZK"
      },
      "vat": 23.5,
      "quantity": 1,
      "referencedSku": "A9999"
    }
  ],
  "recommendedProducts": [
    {
      "type": "PRODUCT",
      "sku": "A1234",
      "name": "Awesome product",
      "description": "So awesome you must have it!",
      "url": "https://mycoolshop.com/product/A1234",
      "image": "https://mycoolshop.com/img/product/A1234.png",
      "price": {
        "amount": 99.96,
        "currency": "CZK"
      }
    }
  ],
  "inUrgentState": true,
  "inImportantState": true,
  "malfunction": true,
  "snooze": {
    "until": "2022-02-16T10:48:11Z",
    "author": "John Doe",
    "note": "Resolved",
    "snoozed": false
  },
  "created": "2023-09-02T13:05:01.636Z",
  "updated": "2023-09-02T19:55:41.301Z",
  "invoiceFileUrl": "https://storage.url/invoices/11111111-2222-3333-4444-555555555555/123456.pdf",
  "proformaInvoiceFileUrl": "https://storage.url/invoices/11111111-2222-3333-4444-555555555555/123456.pdf",
  "files": [
    {
      "id": "string",
      "name": "string",
      "url": "string",
      "contentType": "string"
    }
  ],
  "links": {
    "trackAndTrace": {
      "href": "string"
    }
  },
  "billingDetails": {
    "name": "John Doe",
    "companyName": "Doe Ltd",
    "billingAddress": {
      "line1": "Sesame street",
      "line2": "11b",
      "city": "MyCoolCity",
      "postalCode": "48228",
      "countryCode": "US",
      "state": "Michigan",
      "region": "Michigan",
      "longitude": 50.0933864,
      "latitude": 14.4542789
    },
    "crn": "12345678",
    "vatId": "CZ12345678",
    "email": "johndoe@mail.com",
    "phone": "+420 123 456 789"
  },
  "language": "cs",
  "communication": {
    "optional url of order in external system; typically order url in eshop": "string",
    "externalLinks": [
      {
        "name": "Invoice",
        "url": "https://example.com/invoice.pdf",
        "icon": "FILE"
      }
    ]
  }
}

application/problem+json

Schema

Schema

id uuidrequired

identifier of order

platform string
Name of data source
Example: shopify
orderNumber string
External number of order in eshop
Example: A123456789
orderState OrderState (string)required
State of order
Possible values: [CREATED, PICKING, IN_TRANSIT, PARTIALLY_DELIVERED, DELIVERED, UNDELIVERED, CANCELLED, RETURNED]
Example: IN_TRANSIT
marketId uuidrequired
Id of Market order belongs to
Example: edf4b2ec-c1fc-42da-ba86-eb3a236cd565
eshopId uuidrequired
Id of Eshop order belongs to
Example: edf4b2ec-c1fc-42da-ba86-eb3a236cd565
externalCreated date-time
moment in time when was order created in external system.
Example: 2012-12-31T23:59:59Z
externalIdentifier string
Optional identifier of order in external system
Example: ORD123456789

destination

object

Destination of order - either house address or parcelShop/box

type DestinationType (string)required

Type of destination

Possible values: [PARCEL_SHOP, PARCEL_BOX, HOUSE_ADDRESS]

Example: HOUSE_ADDRESS

address

object

Address details

line1 string

address line1

Example: Sesame street

line2 string

address line2

Example: 11b

city string

Example: MyCoolCity

postalCode string

Example: 48228

countryCode CountryCode (string)

ISO-3166 code of country where ParcelShop/Box is located

Possible values: [UNDEFINED, AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BU, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CP, CR, CS, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, EU, EZ, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NT, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SF, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SU, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UK, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XU, XK, YE, YT, YU, ZA, ZM, ZR, ZW]

Example: US

state string

optional address state

Example: Michigan

region string

optional address region

Example: Michigan

longitude double

GPS longitude

Example: 50.0933864

latitude double

GPS latitude

Example: 14.4542789

parcelShop

object

Details about carriers parcelShop/Box to deliver to

carrier Carrier (string)required

carrier identifier

Possible values: [BUDBEE, CZECH_POST, DHL, DIY, DPD, DPD_CZ, DPD_PL, DPD_SK, EU_SHIPMENTS, FAN_COURIER, FEDEX, GEBRUDER_WEISS, GEIS, GLS, GLS_CZ, GLS_HR, GLS_HU, GLS_RO, GLS_SI, GLS_SK, GO_BALIK, INPOST, JAPO, KURIER_123, KURYR_123, LANDMARK, MESSENGER, PACKETA, PBH, POST_AG, POCZTA_POLSKA, PPL, PPL_CPL, SAMEDAY, SAMEDAY_RO, SLOVAKIA_POST, SPEEDY, SPRING_GDS, SPS, SWISS_POST, TAXYDROMIKI, TOP_TRANS, ULOZENKA, URGENT_CARGUS, UNKNOWN, UPS, WEDO, PERSONAL_PICKUP]

Example: GLS

countryCode CountryCode (string)

ISO-3166 code of country where ParcelShop/Box is located

Possible values: [UNDEFINED, AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BU, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CP, CR, CS, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, EU, EZ, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NT, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SF, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SU, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UK, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XU, XK, YE, YT, YU, ZA, ZM, ZR, ZW]

Example: US

parcelShopId string

Carriers ID of parcelShop/Box

Example: A1234

pickupPlaceId string

businessHours string

price

object

amount of money in given currency

amount numberrequired

amount of money

Example: 99.96

currency stringrequired

currency of amount in ISO-4217 format

Example: CZK

additionalCosts

object[]

required

List of additional costs

Array [

type AdditionalCostType (string)required

Type of additional cost

Possible values: [SHIPPING, CASH_ON_DELIVERY, CARD, BANK_TRANSFER, CASH, PACKING, DUTY, OTHER]

Example: SHIPPING

price

object

required

amount of money in given currency

amount numberrequired

amount of money

Example: 99.96

currency stringrequired

currency of amount in ISO-4217 format

Example: CZK

name string

Name of cost

Possible values: Value must match regular expression ^(?!\s*$).+

Example: Home delivery

]

cashOnDelivery

object

amount of money in given currency

amount numberrequired

amount of money

Example: 99.96

currency stringrequired

currency of amount in ISO-4217 format

Example: CZK

payment

object

Information about payment

paid booleandeprecated

state of payment. DEPRECATION NOTICE: marked for removal, use state instead

Example: false

state PaymentState (string)required

State of payment

Possible values: [UNKNOWN, UNPAID, PAID]

Example: PAID

tag PaymentTag (string)

Optional tag related to UNPAID state of payment

Possible values: [AWAITING_30MIN, AWAITING_1DAY, AWAITING_2DAYS, AWAITING_3DAYS, AWAITING_4DAYS, AWAITING_5DAYS, AWAITING]

Example: AWAITING_30MIN

method PaymentMethod (string)required

Method used for payment

Possible values: [CASH_ON_DELIVERY, BANK_TRANSFER, CARD, CRYPTO, OTHER]

Example: CASH_ON_DELIVERY

service PaymentService (string)required

Type of service used for payment

Possible values: [PAYPAL, APPLE_PAY, GOOGLE_PAY, OTHER]

Example: PAYPAL

link string

payment link

Example: https://pay.me

customer

object

Customer details - name, phone, email

name stringrequired

Customer name

Example: John Doe

email stringrequired

Customer email

Example: iboughtsomething@customer.com

phone stringrequired

Customer phone

Example: +420 123 456 789

parcels

object[]

required

Parcels contained in this order

Array [

id uuidrequired

identifier of parcel

Example: 2b54b81f-1ba6-4196-acc9-894d958bbce7

orderId uuidrequired

id of order this parcel belongs to

Example: 1cad6be8-5bcc-43ff-b9be-a4ed53a2bce1

externalCreated date-time

moment in time when was parcel created in external system.

Example: 2012-12-31T23:59:59Z

dimensions

object

Parcel dimensions

weight double

Package weight in kg

Example: 1.2

height int32

Package height in cm

Example: 25

length int32

Package length in cm

Example: 30

width int32

Package width in cm

Example: 20

deliveryDetails

object

details about order delivery if available

estimatedDeliveryDate date

Date of estimated delivery

Example: 2024-04-18

delay

object

Delivery delay details

delayed boolean

If delivery is delayed

Example: true

reason string

The reason for the delay

Example: The manufacturer is on strike

pin string

optional PIN for pickup

state

object

State of parcel

delivery DeliveryState (string)

state of delivery

Possible values: [CREATED, ESHOP_PROCESSING, MANUFACTURING, AVAILABLE_FROM_MANUFACTURER, PICKING, READY_TO_SEND, HANDED_TO_CARRIER, IN_TRANSIT, STORED_FOR_PICKUP, DELIVERED, RETURNED, LOST, CANCELLED, EXPIRED]

Example: STORED_FOR_PICKUP

important ImportantState (string)deprecated

optional important state assigned to parcel. value is not assigned if parcel is not marked as important

Possible values: [BAD_RATING, MALFUNCTION, TIME_REASONS, ACT_OF_GOD, CARRIERS_FAULT, DAMAGED, NOT_REACHED, DISPOSITION_CHANGE, RETURNING, SLIGHTLY_DELAYED, NOT_PICKED_1DAY, NOT_PICKED_2DAYS, NOT_PICKED_3DAYS]

urgent UrgentState (string)deprecated

optional urgent state assigned to parcel. value is not assigned if parcel is not marked as urgent

Possible values: [REJECTED_FOR_DELIVERY, REJECTED_TAKEOVER, INCORRECT_ADDRESS, OTHER, DELIVERY_DELAYED, NOT_PICKED_4DAYS, NOT_PICKED_5DAYS, LAST_DAY_FOR_PICKUP]

deliverToday boolean

is parcel being delivered today?

returning boolean

is parcel returning back to sender?

trackingState TrackingState (string)

state of parcel tracking

Possible values: [AWAITING, SUSPENDED, TRACKING, MISSING_CREDENTIALS, INVALID_CREDENTIALS, MISSING_CARRIER_CONFIGURATION, INACTIVE_CARRIER_CONFIGURATION, EXPIRED, CANCELLED, MISSING_TRACKING_NUMBER, INVALID_TRACKING_NUMBER, UNKNOWN_TRACKING_NUMBER, DONE]

maxStoreDate date-time

deliveryWindow

object

time window described by two moments in time; beginning and end

from date-time

moment in time when time window starts

to date-time

moment in time when time window ends

activeTracking

object

Tracking of parcel in specific carrier system

trackingId uuidrequired

identifier of this tracking

Example: 2b54b81f-1ba6-4196-acc9-894d958bbce7

carrier Carrier (string)required

carrier identifier

Possible values: [BUDBEE, CZECH_POST, DHL, DIY, DPD, DPD_CZ, DPD_PL, DPD_SK, EU_SHIPMENTS, FAN_COURIER, FEDEX, GEBRUDER_WEISS, GEIS, GLS, GLS_CZ, GLS_HR, GLS_HU, GLS_RO, GLS_SI, GLS_SK, GO_BALIK, INPOST, JAPO, KURIER_123, KURYR_123, LANDMARK, MESSENGER, PACKETA, PBH, POST_AG, POCZTA_POLSKA, PPL, PPL_CPL, SAMEDAY, SAMEDAY_RO, SLOVAKIA_POST, SPEEDY, SPRING_GDS, SPS, SWISS_POST, TAXYDROMIKI, TOP_TRANS, ULOZENKA, URGENT_CARGUS, UNKNOWN, UPS, WEDO, PERSONAL_PICKUP]

Example: GLS

number string

tracking number in carrier system

Example: A1234567890

url string

url of tracking page in carrier system

Example: https://gls-group.eu/CZ/cs/sledovani-zasilek?match=A1234567890

referenceId string

optional id to reference parcel in carrier tracking system

Example: ax72dd

carrierConfigurationId uuid

optional id of carrier configuration in Foxdeli. Carrier configuration is used for communication with carrier api. If no value is provided and carrier requires authorization, primary carrier configuration for given carrier will be used.

courierPhone string

optional phone number of courier that is transporting parcel

timeline

object[]

required

Parcel timeline

Array [

timelineId uuid

Unique id of record

Example: 12345678-1234-1234-1234-1234567890ab

type TimelineType (string)

Type of timeline record

Possible values: [NOTE, COMMUNICATION, ISSUE_COMMUNICATION, TRACKING, ISSUE_TRACKING]

Example: NOTE

text string

Text of record

Example: The client has changed the payment type

created date-time

moment in time when timeline record has been created

Example: 2022-02-16T10:48:11Z

author string

author of record

Example: Malina Red

additionalParams

object

Additional parameters related to timeline record

shippingEmail

object

details about email communication related to timeline records of type COMMUNICATION

recipient string

emailId uuid

emailConfigId uuid

campaignId uuid

state WorkflowState (string)

Possible values: [ACT_OF_GOD, AVAILABLE_FROM_MANUFACTURER, CANCELLED, CARRIERS_FAULT, CROSS_BORDER, DAMAGED, DELIVERED, DELIVERY_DELAYED, DELIVERY_TODAY, DISPOSITION_CHANGED, ESHOP_PROCESSING, ESTIMATED_DELIVERY_DATE, ESTIMATED_DELIVERY_DATE_DELAY, EXPIRED, HANDED_TO_CARRIER, INCORRECT_ADDRESS, IN_TRANSIT, LAST_PICKUP_DAY, LOST, MALFUNCTION, MANUFACTURING, NOT_PICKED_UP_1DAY, NOT_PICKED_UP_2DAYS, NOT_PICKED_UP_3DAYS, NOT_PICKED_UP_4DAYS, NOT_PICKED_UP_5DAYS, NOT_REACHED, ORDER_ACCEPTED, ORDER_CONTENT_CHANGED, ORDER_DESTINATION_CHANGED, ORDER_PAID, ORDER_UNPAID, ORDER_WAITING_FOR_PAYMENT, ORDER_WAITING_FOR_PAYMENT_1DAY, ORDER_WAITING_FOR_PAYMENT_2DAYS, ORDER_WAITING_FOR_PAYMENT_30MIN, ORDER_WAITING_FOR_PAYMENT_3DAYS, ORDER_WAITING_FOR_PAYMENT_4DAYS, ORDER_WAITING_FOR_PAYMENT_5DAYS, OTHER, PICKING, RATING, RATING_1_STAR, RATING_2_STAR, RATING_3_STAR, RATING_4_STAR, RATING_5_STAR, READY_TO_PICKUP, READY_TO_PICKUP_BOX, READY_TO_PICKUP_RETAIL, READY_TO_SEND, REJECTED_DELIVERY, REJECTED_FOR_DELIVERY, RETURNED, RETURNING, SLIGHTLY_DELAYED, TIME_REASONS]

Example: IN_TRANSIT

event EmailEventType (string)

type of event for email communication

Possible values: [EMAIL_SENT, EMAIL_PROCESSED, EMAIL_DROPPED, EMAIL_DELIVERED, EMAIL_DEFERRED, EMAIL_BOUNCED, EMAIL_BLOCKED, EMAIL_OPENED, EMAIL_CLICKED, EMAIL_SPAM_REPORT, EMAIL_UNSUBSCRIBED, EMAIL_GROUP_UNSUBSCRIBED, EMAIL_GROUP_RESUBSCRIBED]

occurred date-time

parcelState

object

descriptor of parcel state that is related to created tracking timeline entry

delivery DeliveryState (string)

state of delivery

Possible values: [CREATED, ESHOP_PROCESSING, MANUFACTURING, AVAILABLE_FROM_MANUFACTURER, PICKING, READY_TO_SEND, HANDED_TO_CARRIER, IN_TRANSIT, STORED_FOR_PICKUP, DELIVERED, RETURNED, LOST, CANCELLED, EXPIRED]

Example: STORED_FOR_PICKUP

important ImportantState (string)deprecated

optional important state assigned to parcel. value is not assigned if parcel is not marked as important

Possible values: [BAD_RATING, MALFUNCTION, TIME_REASONS, ACT_OF_GOD, CARRIERS_FAULT, DAMAGED, NOT_REACHED, DISPOSITION_CHANGE, RETURNING, SLIGHTLY_DELAYED, NOT_PICKED_1DAY, NOT_PICKED_2DAYS, NOT_PICKED_3DAYS]

urgent UrgentState (string)deprecated

optional urgent state assigned to parcel. value is not assigned if parcel is not marked as urgent

Possible values: [REJECTED_FOR_DELIVERY, REJECTED_TAKEOVER, INCORRECT_ADDRESS, OTHER, DELIVERY_DELAYED, NOT_PICKED_4DAYS, NOT_PICKED_5DAYS, LAST_DAY_FOR_PICKUP]

deliverToday boolean

is parcel being delivered today?

returning boolean

is parcel returning back to sender?

parcelStateGroup string

optional group identifier computed from parcel state to determine if two parcel states represent same logical parcel state

parcelTrace

object

deprecated

descriptor of parcel trace that is related to created tracking timeline entry. parcel trace is a container that holds tracking state fields provided by carrier tracking system.

created date-time

moment in time when was this trace created in foxdeli system

occurred date-time

moment in time when tracking event that represents this trace happened in carrier tracking system

carrier Carrier (string)

carrier identifier

Possible values: [BUDBEE, CZECH_POST, DHL, DIY, DPD, DPD_CZ, DPD_PL, DPD_SK, EU_SHIPMENTS, FAN_COURIER, FEDEX, GEBRUDER_WEISS, GEIS, GLS, GLS_CZ, GLS_HR, GLS_HU, GLS_RO, GLS_SI, GLS_SK, GO_BALIK, INPOST, JAPO, KURIER_123, KURYR_123, LANDMARK, MESSENGER, PACKETA, PBH, POST_AG, POCZTA_POLSKA, PPL, PPL_CPL, SAMEDAY, SAMEDAY_RO, SLOVAKIA_POST, SPEEDY, SPRING_GDS, SPS, SWISS_POST, TAXYDROMIKI, TOP_TRANS, ULOZENKA, URGENT_CARGUS, UNKNOWN, UPS, WEDO, PERSONAL_PICKUP]

Example: GLS

trackingNumber string

tracking number of parcel related to tracking event

identifier string

identifier of parcel tracking state in carrier tracking system

text string

optional text containing additional details related to state of parcel

issueTracking

object

details about issue tracking related to timeline records of type ISSUE_TRACKING

type string

externalUrl string

]

products string[]required

Products from order that are contained in this parcel

tags ParcelTag (string)[]required

Optional tags assigned to parcel

Possible values: [TRACKING_SUSPENDED]

carrierTrackingUrl stringdeprecated

Full url to courier's original tracking page. DEPRECATION NOTICE: marked for removal. use activeTracking.url instead.

created date-time

when was parcel created

Example: 2023-09-02T13:05:01.636Z

updated date-time

when was parcel last updated

Example: 2023-09-02T19:55:41.301Z

]

products

object[]

required

Products contained in this order

Array [

type ProductType (string)

Type of product

Possible values: [PRODUCT, DIGITAL_PRODUCT, SERVICE, GIFT, DISCOUNT, VOUCHER]

Example: PRODUCT

sku string

product SKU

Example: A1234

name string

name of product

Example: Awesome product

description string

short product description.

Example: So awesome you must have it!

url string

url of product detail.

Example: https://mycoolshop.com/product/A1234

image string

url of product image.

Example: https://mycoolshop.com/img/product/A1234.png

price

object

amount of money in given currency

amount numberrequired

amount of money

Example: 99.96

currency stringrequired

currency of amount in ISO-4217 format

Example: CZK

vat number

VAT value

Example: 23.5

quantity int32

quantity ordered

Possible values: >= 1

Example: 1

referencedSku string

reference to the SKU of the product it belongs to, e.g. extended warranty. references product within same order

Example: A9999

]

recommendedProducts

object[]

required

Products to be displayed in Recommended Products TnT/email module

Array [

type ProductType (string)

Type of product

Possible values: [PRODUCT, DIGITAL_PRODUCT, SERVICE, GIFT, DISCOUNT, VOUCHER]

Example: PRODUCT

sku string

product SKU

Example: A1234

name string

name of product

Example: Awesome product

description string

short product description.

Example: So awesome you must have it!

url string

url of product detail.

Example: https://mycoolshop.com/product/A1234

image string

url of product image.

Example: https://mycoolshop.com/img/product/A1234.png

price

object

amount of money in given currency

amount numberrequired

amount of money

Example: 99.96

currency stringrequired

currency of amount in ISO-4217 format

Example: CZK

]

cancelled date-timedeprecated

Instant of cancellation. DEPRECATION NOTICE: field is marked for removal and will be removed in one of next major releases

inUrgentState boolean
is order in urgent state?
Example: true
inImportantState boolean
is order in important state?
Example: true
malfunction boolean
is order in malfunction state?
Example: true

snooze

object

Snooze details

until date-time

moment in time until which order is snoozed

Example: 2022-02-16T10:48:11Z

author string

author of snooze

Example: John Doe

note string

snooze note

Example: Resolved

snoozed boolean

is snooze currently active?

Example: false
created date-time
moment in time when was order created
Example: 2023-09-02T13:05:01.636Z
updated date-time
moment in time when was order last updated
Example: 2023-09-02T19:55:41.301Z
invoiceFileUrl string
(Foxdeli storage) URL of the invoice that belongs to this order (optional)
Example: https://storage.url/invoices/11111111-2222-3333-4444-555555555555/123456.pdf
proformaInvoiceFileUrl string
(Foxdeli storage) URL of the proforma invoice that belongs to this order (optional)
Example: https://storage.url/invoices/11111111-2222-3333-4444-555555555555/123456.pdf

files

object[]

required

List of files attached to order

Array [

id string

identifier of file

name string

name of a file

url string

url to access file content

contentType string

content type of file

]

links

object

required

trackAndTrace

object

required

link to a resource

href string

billingDetails

object

Billing details

name string

Name

Example: John Doe

companyName string

Company name

Example: Doe Ltd

billingAddress

object

Address details

line1 string

address line1

Example: Sesame street

line2 string

address line2

Example: 11b

city string

Example: MyCoolCity

postalCode string

Example: 48228

countryCode CountryCode (string)

ISO-3166 code of country where ParcelShop/Box is located

Possible values: [UNDEFINED, AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BU, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CP, CR, CS, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, EU, EZ, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NT, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SF, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SU, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UK, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XU, XK, YE, YT, YU, ZA, ZM, ZR, ZW]

Example: US

state string

optional address state

Example: Michigan

region string

optional address region

Example: Michigan

longitude double

GPS longitude

Example: 50.0933864

latitude double

GPS latitude

Example: 14.4542789

crn string

Company Registration Number

Example: 12345678

vatId string

Value Added Tax Number

Example: CZ12345678

email string

Email address

Example: johndoe@mail.com

phone string

Phone number

Example: +420 123 456 789
language LanguageCode (string)
Order language - two letter language code - ISO-639-1
Possible values: [undefined, aa, ab, ae, af, ak, am, an, ar, as, av, ay, az, ba, be, bg, bh, bi, bm, bn, bo, br, bs, ca, ce, ch, co, cr, cs, cu, cv, cy, da, de, dv, dz, ee, el, en, eo, es, et, eu, fa, ff, fi, fj, fo, fr, fy, ga, gd, gl, gn, gu, gv, ha, he, hi, ho, hr, ht, hu, hy, hz, ia, id, ie, ig, ii, ik, io, is, it, iu, ja, jv, ka, kg, ki, kj, kk, kl, km, kn, ko, kr, ks, ku, kv, kw, ky, la, lb, lg, li, ln, lo, lt, lu, lv, mg, mh, mi, mk, ml, mn, mr, ms, mt, my, na, nb, nd, ne, ng, nl, nn, no, nr, nv, ny, oc, oj, om, or, os, pa, pi, pl, ps, pt, qu, rm, rn, ro, ru, rw, sa, sc, sd, se, sg, si, sk, sl, sm, sn, so, sq, sr, ss, st, su, sv, sw, ta, te, tg, th, ti, tk, tl, tn, to, tr, ts, tt, tw, ty, ug, uk, ur, uz, ve, vi, vo, wa, wo, xh, yi, yo, za, zh, zu]
Example: cs

externalLinks

object[]

deprecated

list of order external links. DEPRECATION NOTICE: marked for removal. use communication.externalLinks instead.

Array [

name string

link name

Example: Invoice

url string

link url

Example: https://example.com/invoice.pdf

icon ExternalLinkIcon (string)

External Link Icon

Possible values: [LINK, FILE]

Example: FILE

]

communication

object

required

Customization of communication for given order

optional url of order in external system; typically order url in eshop string

externalLinks

object[]

Array [

name string

link name

Example: Invoice

url stringrequired

link url

Example: https://example.com/invoice.pdf

icon ExternalLinkIcon (string)

External Link Icon

Possible values: [LINK, FILE]

Example: FILE

]

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "platform": "shopify",
  "orderNumber": "A123456789",
  "orderState": "IN_TRANSIT",
  "marketId": "edf4b2ec-c1fc-42da-ba86-eb3a236cd565",
  "eshopId": "edf4b2ec-c1fc-42da-ba86-eb3a236cd565",
  "externalCreated": "2012-12-31T23:59:59Z",
  "externalIdentifier": "ORD123456789",
  "destination": {
    "type": "HOUSE_ADDRESS",
    "address": {
      "line1": "Sesame street",
      "line2": "11b",
      "city": "MyCoolCity",
      "postalCode": "48228",
      "countryCode": "US",
      "state": "Michigan",
      "region": "Michigan",
      "longitude": 50.0933864,
      "latitude": 14.4542789
    },
    "parcelShop": {
      "carrier": "GLS",
      "countryCode": "US",
      "parcelShopId": "A1234",
      "pickupPlaceId": "string",
      "businessHours": "string"
    }
  },
  "price": {
    "amount": 99.96,
    "currency": "CZK"
  },
  "additionalCosts": [
    {
      "type": "SHIPPING",
      "price": {
        "amount": 99.96,
        "currency": "CZK"
      },
      "name": "Home delivery"
    }
  ],
  "cashOnDelivery": {
    "amount": 99.96,
    "currency": "CZK"
  },
  "payment": {
    "state": "PAID",
    "tag": "AWAITING_30MIN",
    "method": "CASH_ON_DELIVERY",
    "service": "PAYPAL",
    "link": "https://pay.me"
  },
  "customer": {
    "name": "John Doe",
    "email": "iboughtsomething@customer.com",
    "phone": "+420 123 456 789"
  },
  "parcels": [
    {
      "id": "2b54b81f-1ba6-4196-acc9-894d958bbce7",
      "orderId": "1cad6be8-5bcc-43ff-b9be-a4ed53a2bce1",
      "externalCreated": "2012-12-31T23:59:59Z",
      "dimensions": {
        "weight": 1.2,
        "height": 25,
        "length": 30,
        "width": 20
      },
      "deliveryDetails": {
        "estimatedDeliveryDate": "2024-04-18",
        "delay": {
          "delayed": true,
          "reason": "The manufacturer is on strike"
        }
      },
      "pin": "string",
      "state": {
        "delivery": "STORED_FOR_PICKUP",
        "deliverToday": true,
        "returning": true
      },
      "trackingState": "AWAITING",
      "maxStoreDate": "2024-07-29T15:51:28.071Z",
      "deliveryWindow": {
        "from": "2024-07-29T15:51:28.071Z",
        "to": "2024-07-29T15:51:28.071Z"
      },
      "activeTracking": {
        "trackingId": "2b54b81f-1ba6-4196-acc9-894d958bbce7",
        "carrier": "GLS",
        "number": "A1234567890",
        "url": "https://gls-group.eu/CZ/cs/sledovani-zasilek?match=A1234567890",
        "referenceId": "ax72dd",
        "carrierConfigurationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "courierPhone": "string"
      },
      "timeline": [
        {
          "timelineId": "12345678-1234-1234-1234-1234567890ab",
          "type": "NOTE",
          "text": "The client has changed the payment type",
          "created": "2022-02-16T10:48:11Z",
          "author": "Malina Red",
          "additionalParams": {
            "shippingEmail": {
              "recipient": "string",
              "emailId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "emailConfigId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "campaignId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "state": "IN_TRANSIT",
              "event": "EMAIL_SENT",
              "occurred": "2024-07-29T15:51:28.071Z"
            },
            "parcelState": {
              "delivery": "STORED_FOR_PICKUP",
              "deliverToday": true,
              "returning": true
            },
            "parcelStateGroup": "string",
            "issueTracking": {
              "type": "string",
              "externalUrl": "string"
            }
          }
        }
      ],
      "products": [
        "string"
      ],
      "tags": [
        "TRACKING_SUSPENDED"
      ],
      "created": "2023-09-02T13:05:01.636Z",
      "updated": "2023-09-02T19:55:41.301Z"
    }
  ],
  "products": [
    {
      "type": "PRODUCT",
      "sku": "A1234",
      "name": "Awesome product",
      "description": "So awesome you must have it!",
      "url": "https://mycoolshop.com/product/A1234",
      "image": "https://mycoolshop.com/img/product/A1234.png",
      "price": {
        "amount": 99.96,
        "currency": "CZK"
      },
      "vat": 23.5,
      "quantity": 1,
      "referencedSku": "A9999"
    }
  ],
  "recommendedProducts": [
    {
      "type": "PRODUCT",
      "sku": "A1234",
      "name": "Awesome product",
      "description": "So awesome you must have it!",
      "url": "https://mycoolshop.com/product/A1234",
      "image": "https://mycoolshop.com/img/product/A1234.png",
      "price": {
        "amount": 99.96,
        "currency": "CZK"
      }
    }
  ],
  "inUrgentState": true,
  "inImportantState": true,
  "malfunction": true,
  "snooze": {
    "until": "2022-02-16T10:48:11Z",
    "author": "John Doe",
    "note": "Resolved",
    "snoozed": false
  },
  "created": "2023-09-02T13:05:01.636Z",
  "updated": "2023-09-02T19:55:41.301Z",
  "invoiceFileUrl": "https://storage.url/invoices/11111111-2222-3333-4444-555555555555/123456.pdf",
  "proformaInvoiceFileUrl": "https://storage.url/invoices/11111111-2222-3333-4444-555555555555/123456.pdf",
  "files": [
    {
      "id": "string",
      "name": "string",
      "url": "string",
      "contentType": "string"
    }
  ],
  "links": {
    "trackAndTrace": {
      "href": "string"
    }
  },
  "billingDetails": {
    "name": "John Doe",
    "companyName": "Doe Ltd",
    "billingAddress": {
      "line1": "Sesame street",
      "line2": "11b",
      "city": "MyCoolCity",
      "postalCode": "48228",
      "countryCode": "US",
      "state": "Michigan",
      "region": "Michigan",
      "longitude": 50.0933864,
      "latitude": 14.4542789
    },
    "crn": "12345678",
    "vatId": "CZ12345678",
    "email": "johndoe@mail.com",
    "phone": "+420 123 456 789"
  },
  "language": "cs",
  "communication": {
    "optional url of order in external system; typically order url in eshop": "string",
    "externalLinks": [
      {
        "name": "Invoice",
        "url": "https://example.com/invoice.pdf",
        "icon": "FILE"
      }
    ]
  }
}

400

Input data validation error - constraint violation.

application/problem+json

Schema

Schema

type uri
title string
status int32
detail string
instance uri

properties

object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

401

Invalid API token provided.

application/problem+json

Schema

Schema

type uri
title string
status int32
detail string
instance uri

properties

object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

403

AccessDeniedException

*/*

Schema

Schema

type uri
title string
status int32
detail string
instance uri

properties

object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

404

Order to update was not found.

application/problem+json

Schema

Schema

type uri
title string
status int32
detail string
instance uri

properties

object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

409

Attempt to remove a product that is already contained in a parcel

application/problem+json

Schema

Schema

type uri
title string
status int32
detail string
instance uri

properties

object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

Loading...