Update existing order
PATCH/api/v1/order/:orderId
Updates existing order
Request
Path Parameters
id of order to update.
- application/json
Body
required
Order data to update.
Array [
]
Array [
]
Array [
]
Array [
]
name of data source
external number of order in eshop
optional moment in time when was order created in external system.
optional identifier of order in external system. If provided, must be unique for each order.
price
object
amount of money in given currency
amount of money
currency of amount in ISO-4217 format
cashOnDelivery
object
amount of money in given currency
amount of money
currency of amount in ISO-4217 format
additionalCosts
object[]
Possible values: [SHIPPING
, CASH_ON_DELIVERY
, CARD
, BANK_TRANSFER
, CASH
, PACKING
, DUTY
, OTHER
]
Type of additional cost
price
object
required
amount of money in given currency
amount of money
currency of amount in ISO-4217 format
Possible values: Value must match regular expression ^(?!\s*$).+
name of cost
payment
object
Information about payment
state of payment
Possible values: [CASH_ON_DELIVERY
, BANK_TRANSFER
, CARD
, CRYPTO
, OTHER
]
Method used for payment
Possible values: [PAYPAL
, APPLE_PAY
, GOOGLE_PAY
, OTHER
]
Type of service used for payment
payment link
customer
object
Customer details - name, phone, email
Customer name
Customer email
Customer phone
destination
object
Destination of order - either house address or parcelShop/box
Possible values: [PARCEL_SHOP
, PARCEL_BOX
, HOUSE_ADDRESS
]
Type of destination
address
object
address details; required data for destination type HOUSE_ADDRESS
address line1
address line2
city name
zip code
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
]
ISO-3166 code of country where ParcelShop/Box is located
optional address state
optional address region
GPS longitude
GPS latitude
parcelShop
object
parcel shop/box details; required data for destination type PARCEL_SHOP|PARCEL_BOX
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
]
carrier identifier
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
]
ISO-3166 code of country where ParcelShop/Box is located
identifier of of parcelShop/Box in carrier system
products
object[]
Possible values: [PRODUCT
, DIGITAL_PRODUCT
, SERVICE
, GIFT
, DISCOUNT
, VOUCHER
]
Type of product
product SKU
name of product
short product description.
url of product detail.
url of product image.
price
object
amount of money in given currency
amount of money
currency of amount in ISO-4217 format
VAT value
Possible values: >= 1
quantity ordered
reference to the SKU of product that this product belongs to, e.g. extended warranty. references product within same order
recommendedProducts
object[]
Possible values: [PRODUCT
, DIGITAL_PRODUCT
, SERVICE
, GIFT
, DISCOUNT
, VOUCHER
]
Type of product
product SKU
name of product
short product description.
url of product detail.
url of product image.
price
object
amount of money in given currency
amount of money
currency of amount in ISO-4217 format
billingDetails
object
Billing details
Name
Company name
billingAddress
object
address details; required data for destination type HOUSE_ADDRESS
address line1
address line2
city name
zip code
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
]
ISO-3166 code of country where ParcelShop/Box is located
optional address state
optional address region
GPS longitude
GPS latitude
Company Registration Number
Value Added Tax Number
Email address
Phone number
externalLinks
object[]
link name
link url
Possible values: [LINK
, FILE
]
External Link Icon
Responses
- 200
- 400
- 401
- 403
- 404
- 409
Order successfully updated.
- application/json
- application/problem+json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
Array [
]
]
Array [
]
Array [
]
Array [
]
identifier of order
Name of data source
External number of order in eshop
Possible values: [CREATED
, PICKING
, IN_TRANSIT
, PARTIALLY_DELIVERED
, DELIVERED
, UNDELIVERED
, CANCELLED
, RETURNED
]
State of order
Id of Market order belongs to
Id of Eshop order belongs to
moment in time when was order created in external system.
Optional identifier of order in external system
destination
object
Destination of order - either house address or parcelShop/box
Possible values: [PARCEL_SHOP
, PARCEL_BOX
, HOUSE_ADDRESS
]
Type of destination
address
object
Address details
address line1
address line2
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
]
ISO-3166 code of country where ParcelShop/Box is located
optional address state
optional address region
GPS longitude
GPS latitude
parcelShop
object
Details about carriers parcelShop/Box to deliver to
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
]
carrier identifier
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
]
ISO-3166 code of country where ParcelShop/Box is located
Carriers ID of parcelShop/Box
price
object
amount of money in given currency
amount of money
currency of amount in ISO-4217 format
additionalCosts
object[]
List of additional costs
Possible values: [SHIPPING
, CASH_ON_DELIVERY
, CARD
, BANK_TRANSFER
, CASH
, PACKING
, DUTY
, OTHER
]
Type of additional cost
price
object
required
amount of money in given currency
amount of money
currency of amount in ISO-4217 format
Possible values: Value must match regular expression ^(?!\s*$).+
Name of cost
cashOnDelivery
object
amount of money in given currency
amount of money
currency of amount in ISO-4217 format
payment
object
Information about payment
state of payment
Possible values: [CASH_ON_DELIVERY
, BANK_TRANSFER
, CARD
, CRYPTO
, OTHER
]
Method used for payment
Possible values: [PAYPAL
, APPLE_PAY
, GOOGLE_PAY
, OTHER
]
Type of service used for payment
payment link
customer
object
Customer details - name, phone, email
Customer name
Customer email
Customer phone
parcels
object[]
Parcels contained in this order
identifier of parcel
id of order this parcel belongs to
moment in time when was parcel created in external system.
dimensions
object
Parcel dimensions
Package weight in kg
Package height in cm
Package length in cm
Package width in cm
deliveryDetails
object
Delivery details
Date of estimated delivery
delay
object
Delivery delay details
If delivery is delayed
The reason for the delay
PIN for pickup
state
object
State of parcel
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
]
state of delivery
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
]
optional important state assigned to parcel. value is not assigned if parcel is not marked as important
Possible values: [REJECTED_FOR_DELIVERY
, REJECTED_TAKEOVER
, INCORRECT_ADDRESS
, OTHER
, DELIVERY_DELAYED
, NOT_PICKED_4DAYS
, NOT_PICKED_5DAYS
, LAST_DAY_FOR_PICKUP
]
optional urgent state assigned to parcel. value is not assigned if parcel is not marked as urgent
is parcel being delivered today?
is parcel returning back to sender?
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
]
State of parcel tracking
deliveryWindow
object
time window described by two moments in time; beginning and end
moment in time when time window starts
moment in time when time window ends
activeTracking
object
Tracking of parcel in specific carrier system
identifier of this tracking
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
]
carrier identifier
tracking number in carrier system
url of tracking page in carrier system
optional id to reference parcel in carrier tracking system
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.
optional phone number of courier that is transporting parcel
timeline
object[]
required
Parcel timeline
Unique id of record
Possible values: [NOTE
, COMMUNICATION
, ISSUE_COMMUNICATION
, TRACKING
, ISSUE_TRACKING
]
Type of timeline record
Text of record
moment in time when timeline record has been created
author of record
additionalParams
object
Additional parameters related to timeline record
shippingEmail
object
details about email communication related to timeline records of type COMMUNICATION
Possible values: [ORDER_ACCEPTED
, ESHOP_PROCESSING
, MANUFACTURING
, AVAILABLE_FROM_MANUFACTURER
, PICKING
, REJECTED_FOR_DELIVERY
, READY_TO_SEND
, HANDED_TO_CARRIER
, CARRIERS_FAULT
, DAMAGED
, NOT_REACHED
, DISPOSITION_CHANGED
, ORDER_DESTINATION_CHANGED
, ESTIMATED_DELIVERY_DATE
, ESTIMATED_DELIVERY_DATE_DELAY
, SLIGHTLY_DELAYED
, INCORRECT_ADDRESS
, DELIVERY_DELAYED
, IN_TRANSIT
, CROSS_BORDER
, DELIVERY_TODAY
, READY_TO_PICKUP
, READY_TO_PICKUP_BOX
, READY_TO_PICKUP_RETAIL
, NOT_PICKED_UP_1DAY
, NOT_PICKED_UP_2DAYS
, NOT_PICKED_UP_3DAYS
, NOT_PICKED_UP_4DAYS
, NOT_PICKED_UP_5DAYS
, LAST_PICKUP_DAY
, REJECTED_DELIVERY
, RATING
, RATING_1_STAR
, RATING_2_STAR
, RATING_3_STAR
, RATING_4_STAR
, RATING_5_STAR
, RETURNING
, RETURNED
, LOST
, CANCELLED
, EXPIRED
, MALFUNCTION
, TIME_REASONS
, ACT_OF_GOD
, OTHER
, DELIVERED
]
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
]
type of event for email communication
parcelState
object
descriptor of parcel state that is related to created tracking timeline entry
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
]
state of delivery
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
]
optional important state assigned to parcel. value is not assigned if parcel is not marked as important
Possible values: [REJECTED_FOR_DELIVERY
, REJECTED_TAKEOVER
, INCORRECT_ADDRESS
, OTHER
, DELIVERY_DELAYED
, NOT_PICKED_4DAYS
, NOT_PICKED_5DAYS
, LAST_DAY_FOR_PICKUP
]
optional urgent state assigned to parcel. value is not assigned if parcel is not marked as urgent
is parcel being delivered today?
is parcel returning back to sender?
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.
moment in time when was this trace created in foxdeli system
moment in time when tracking event that represents this trace happened in carrier tracking system
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
]
carrier identifier
tracking number of parcel related to tracking event
identifier of parcel tracking state in carrier tracking system
optional text containing additional details related to state of parcel
issueTracking
object
details about issue tracking related to timeline records of type ISSUE_TRACKING
Products from order that are contained in this parcel
Possible values: [TRACKING_SUSPENDED
]
Optional tags assigned to parcel
Full url to courier's original tracking page. DEPRECATION NOTICE: marked for removal. use activeTracking.url instead.
when was parcel created
when was parcel last updated
products
object[]
Products contained in this order
Possible values: [PRODUCT
, DIGITAL_PRODUCT
, SERVICE
, GIFT
, DISCOUNT
, VOUCHER
]
Type of product
product SKU
name of product
short product description.
url of product detail.
url of product image.
price
object
amount of money in given currency
amount of money
currency of amount in ISO-4217 format
VAT value
Possible values: >= 1
quantity ordered
reference to the SKU of the product it belongs to, e.g. extended warranty. references product within same order
recommendedProducts
object[]
Products to be displayed in Recommended Products TnT/email module
Possible values: [PRODUCT
, DIGITAL_PRODUCT
, SERVICE
, GIFT
, DISCOUNT
, VOUCHER
]
Type of product
product SKU
name of product
short product description.
url of product detail.
url of product image.
price
object
amount of money in given currency
amount of money
currency of amount in ISO-4217 format
Instant of cancellation. DEPRECATION NOTICE: field is marked for removal and will be removed in one of next major releases
is order in urgent state?
is order in important state?
is order in malfunction state?
snooze
object
Snooze details
moment in time until which order is snoozed
author of snooze
snooze note
is snooze currently active?
moment in time when was order created
moment in time when was order last updated
(Foxdeli storage) URL of the invoice that belongs to this order (optional)
(Foxdeli storage) URL of the proforma invoice that belongs to this order (optional)
links
object
required
trackAndTrace
object
required
link to a resource
billingDetails
object
Billing details
Name
Company name
billingAddress
object
Address details
address line1
address line2
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
]
ISO-3166 code of country where ParcelShop/Box is located
optional address state
optional address region
GPS longitude
GPS latitude
Company Registration Number
Value Added Tax Number
Email address
Phone number
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
]
Order language - two letter language code - ISO-639-1
externalLinks
object[]
list of order external links
link name
link url
Possible values: [LINK
, FILE
]
External Link Icon
{
"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": {
"paid": false,
"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-07T15:54:49.717Z",
"deliveryWindow": {
"from": "2024-07-07T15:54:49.717Z",
"to": "2024-07-07T15:54:49.717Z"
},
"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-07T15:54:49.717Z"
},
"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",
"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",
"externalLinks": []
}
- Schema
- Example (from schema)
Schema
Array [
]
Array [
Array [
]
]
Array [
]
Array [
]
Array [
]
identifier of order
Name of data source
External number of order in eshop
Possible values: [CREATED
, PICKING
, IN_TRANSIT
, PARTIALLY_DELIVERED
, DELIVERED
, UNDELIVERED
, CANCELLED
, RETURNED
]
State of order
Id of Market order belongs to
Id of Eshop order belongs to
moment in time when was order created in external system.
Optional identifier of order in external system
destination
object
Destination of order - either house address or parcelShop/box
Possible values: [PARCEL_SHOP
, PARCEL_BOX
, HOUSE_ADDRESS
]
Type of destination
address
object
Address details
address line1
address line2
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
]
ISO-3166 code of country where ParcelShop/Box is located
optional address state
optional address region
GPS longitude
GPS latitude
parcelShop
object
Details about carriers parcelShop/Box to deliver to
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
]
carrier identifier
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
]
ISO-3166 code of country where ParcelShop/Box is located
Carriers ID of parcelShop/Box
price
object
amount of money in given currency
amount of money
currency of amount in ISO-4217 format
additionalCosts
object[]
List of additional costs
Possible values: [SHIPPING
, CASH_ON_DELIVERY
, CARD
, BANK_TRANSFER
, CASH
, PACKING
, DUTY
, OTHER
]
Type of additional cost
price
object
required
amount of money in given currency
amount of money
currency of amount in ISO-4217 format
Possible values: Value must match regular expression ^(?!\s*$).+
Name of cost
cashOnDelivery
object
amount of money in given currency
amount of money
currency of amount in ISO-4217 format
payment
object
Information about payment
state of payment
Possible values: [CASH_ON_DELIVERY
, BANK_TRANSFER
, CARD
, CRYPTO
, OTHER
]
Method used for payment
Possible values: [PAYPAL
, APPLE_PAY
, GOOGLE_PAY
, OTHER
]
Type of service used for payment
payment link
customer
object
Customer details - name, phone, email
Customer name
Customer email
Customer phone
parcels
object[]
Parcels contained in this order
identifier of parcel
id of order this parcel belongs to
moment in time when was parcel created in external system.
dimensions
object
Parcel dimensions
Package weight in kg
Package height in cm
Package length in cm
Package width in cm
deliveryDetails
object
Delivery details
Date of estimated delivery
delay
object
Delivery delay details
If delivery is delayed
The reason for the delay
PIN for pickup
state
object
State of parcel
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
]
state of delivery
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
]
optional important state assigned to parcel. value is not assigned if parcel is not marked as important
Possible values: [REJECTED_FOR_DELIVERY
, REJECTED_TAKEOVER
, INCORRECT_ADDRESS
, OTHER
, DELIVERY_DELAYED
, NOT_PICKED_4DAYS
, NOT_PICKED_5DAYS
, LAST_DAY_FOR_PICKUP
]
optional urgent state assigned to parcel. value is not assigned if parcel is not marked as urgent
is parcel being delivered today?
is parcel returning back to sender?
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
]
State of parcel tracking
deliveryWindow
object
time window described by two moments in time; beginning and end
moment in time when time window starts
moment in time when time window ends
activeTracking
object
Tracking of parcel in specific carrier system
identifier of this tracking
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
]
carrier identifier
tracking number in carrier system
url of tracking page in carrier system
optional id to reference parcel in carrier tracking system
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.
optional phone number of courier that is transporting parcel
timeline
object[]
required
Parcel timeline
Unique id of record
Possible values: [NOTE
, COMMUNICATION
, ISSUE_COMMUNICATION
, TRACKING
, ISSUE_TRACKING
]
Type of timeline record
Text of record
moment in time when timeline record has been created
author of record
additionalParams
object
Additional parameters related to timeline record
shippingEmail
object
details about email communication related to timeline records of type COMMUNICATION
Possible values: [ORDER_ACCEPTED
, ESHOP_PROCESSING
, MANUFACTURING
, AVAILABLE_FROM_MANUFACTURER
, PICKING
, REJECTED_FOR_DELIVERY
, READY_TO_SEND
, HANDED_TO_CARRIER
, CARRIERS_FAULT
, DAMAGED
, NOT_REACHED
, DISPOSITION_CHANGED
, ORDER_DESTINATION_CHANGED
, ESTIMATED_DELIVERY_DATE
, ESTIMATED_DELIVERY_DATE_DELAY
, SLIGHTLY_DELAYED
, INCORRECT_ADDRESS
, DELIVERY_DELAYED
, IN_TRANSIT
, CROSS_BORDER
, DELIVERY_TODAY
, READY_TO_PICKUP
, READY_TO_PICKUP_BOX
, READY_TO_PICKUP_RETAIL
, NOT_PICKED_UP_1DAY
, NOT_PICKED_UP_2DAYS
, NOT_PICKED_UP_3DAYS
, NOT_PICKED_UP_4DAYS
, NOT_PICKED_UP_5DAYS
, LAST_PICKUP_DAY
, REJECTED_DELIVERY
, RATING
, RATING_1_STAR
, RATING_2_STAR
, RATING_3_STAR
, RATING_4_STAR
, RATING_5_STAR
, RETURNING
, RETURNED
, LOST
, CANCELLED
, EXPIRED
, MALFUNCTION
, TIME_REASONS
, ACT_OF_GOD
, OTHER
, DELIVERED
]
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
]
type of event for email communication
parcelState
object
descriptor of parcel state that is related to created tracking timeline entry
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
]
state of delivery
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
]
optional important state assigned to parcel. value is not assigned if parcel is not marked as important
Possible values: [REJECTED_FOR_DELIVERY
, REJECTED_TAKEOVER
, INCORRECT_ADDRESS
, OTHER
, DELIVERY_DELAYED
, NOT_PICKED_4DAYS
, NOT_PICKED_5DAYS
, LAST_DAY_FOR_PICKUP
]
optional urgent state assigned to parcel. value is not assigned if parcel is not marked as urgent
is parcel being delivered today?
is parcel returning back to sender?
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.
moment in time when was this trace created in foxdeli system
moment in time when tracking event that represents this trace happened in carrier tracking system
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
]
carrier identifier
tracking number of parcel related to tracking event
identifier of parcel tracking state in carrier tracking system
optional text containing additional details related to state of parcel
issueTracking
object
details about issue tracking related to timeline records of type ISSUE_TRACKING
Products from order that are contained in this parcel
Possible values: [TRACKING_SUSPENDED
]
Optional tags assigned to parcel
Full url to courier's original tracking page. DEPRECATION NOTICE: marked for removal. use activeTracking.url instead.
when was parcel created
when was parcel last updated
products
object[]
Products contained in this order
Possible values: [PRODUCT
, DIGITAL_PRODUCT
, SERVICE
, GIFT
, DISCOUNT
, VOUCHER
]
Type of product
product SKU
name of product
short product description.
url of product detail.
url of product image.
price
object
amount of money in given currency
amount of money
currency of amount in ISO-4217 format
VAT value
Possible values: >= 1
quantity ordered
reference to the SKU of the product it belongs to, e.g. extended warranty. references product within same order
recommendedProducts
object[]
Products to be displayed in Recommended Products TnT/email module
Possible values: [PRODUCT
, DIGITAL_PRODUCT
, SERVICE
, GIFT
, DISCOUNT
, VOUCHER
]
Type of product
product SKU
name of product
short product description.
url of product detail.
url of product image.
price
object
amount of money in given currency
amount of money
currency of amount in ISO-4217 format
Instant of cancellation. DEPRECATION NOTICE: field is marked for removal and will be removed in one of next major releases
is order in urgent state?
is order in important state?
is order in malfunction state?
snooze
object
Snooze details
moment in time until which order is snoozed
author of snooze
snooze note
is snooze currently active?
moment in time when was order created
moment in time when was order last updated
(Foxdeli storage) URL of the invoice that belongs to this order (optional)
(Foxdeli storage) URL of the proforma invoice that belongs to this order (optional)
links
object
required
trackAndTrace
object
required
link to a resource
billingDetails
object
Billing details
Name
Company name
billingAddress
object
Address details
address line1
address line2
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
]
ISO-3166 code of country where ParcelShop/Box is located
optional address state
optional address region
GPS longitude
GPS latitude
Company Registration Number
Value Added Tax Number
Email address
Phone number
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
]
Order language - two letter language code - ISO-639-1
externalLinks
object[]
list of order external links
link name
link url
Possible values: [LINK
, FILE
]
External Link Icon
{
"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": {
"paid": false,
"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-07T15:54:49.721Z",
"deliveryWindow": {
"from": "2024-07-07T15:54:49.721Z",
"to": "2024-07-07T15:54:49.721Z"
},
"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-07T15:54:49.721Z"
},
"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",
"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",
"externalLinks": []
}
Input data validation error - constraint violation.
- application/problem+json
- Schema
- Example (from schema)
Schema
properties
object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Invalid API token provided.
- application/problem+json
- Schema
- Example (from schema)
Schema
properties
object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
AccessDeniedException
- */*
- Schema
- Example (from schema)
Schema
properties
object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Order to update was not found.
- application/problem+json
- Schema
- Example (from schema)
Schema
properties
object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Attempt to remove a product that is already contained in a parcel
- application/problem+json
- Schema
- Example (from schema)
Schema
properties
object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}