Skip to main content

Find existing order

GET 
/api/v1/order/:orderId

Find existing order by id

Request​

Path Parameters

    orderId stringrequired

    id of order to search for

Responses​

Order is found

Schema

    id uuidrequired

    identifier of order

    platform string

    Name of data source

    orderNumber string

    External number of order in eshop

    orderState OrderState (string)

    Possible values: [CREATED, PICKING, IN_TRANSIT, PARTIALLY_DELIVERED, DELIVERED, UNDELIVERED, CANCELLED, RETURNED]

    State of order

    marketId uuid

    Id of Market order belongs to

    eshopId uuid

    Id of Eshop order belongs to

    externalCreated date-time

    moment in time when was order created in external system.

    externalIdentifier string

    Optional identifier of order in external system

    destination

    object

    Destination of order - either house address or parcelShop/box

    type DestinationType (string)required

    Possible values: [PARCEL_SHOP, PARCEL_BOX, HOUSE_ADDRESS]

    Type of destination

    address

    object

    Address details

    line1 string

    address line1

    line2 string

    address line2

    city string
    postalCode string
    countryCode CountryCode (string)

    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

    state string

    optional address state

    region string

    optional address region

    longitude double

    GPS longitude

    latitude double

    GPS latitude

    parcelShop

    object

    Details about carriers parcelShop/Box to deliver to

    carrier Carrier (string)required

    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

    countryCode CountryCode (string)

    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

    parcelShopId string

    Carriers ID of parcelShop/Box

    pickupPlaceId string
    businessHours string

    price

    object

    amount of money in given currency

    amount numberrequired

    amount of money

    currency stringrequired

    currency of amount in ISO-4217 format

    additionalCosts

    object[]

    List of additional costs

  • Array [

    • type AdditionalCostType (string)required

    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 numberrequired

    amount of money

    currency stringrequired

    currency of amount in ISO-4217 format

    name string

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

    Name of cost

  • ]

    • cashOnDelivery

    object

    amount of money in given currency

    amount numberrequired

    amount of money

    currency stringrequired

    currency of amount in ISO-4217 format

    payment

    object

    Information about payment

    paid boolean

    state of payment

    method PaymentMethod (string)

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

    Method used for payment

    service PaymentService (string)

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

    Type of service used for payment

    link string

    payment link

    customer

    object

    Customer details - name, phone, email

    name stringrequired

    Customer name

    email stringrequired

    Customer email

    phone stringrequired

    Customer phone

    parcels

    object[]

    Parcels contained in this order

  • Array [

    • id uuidrequired

    identifier of parcel

    orderId uuidrequired

    id of order this parcel belongs to

    externalCreated date-time

    moment in time when was parcel created in external system.

    dimensions

    object

    Parcel dimensions

    weight double

    Package weight in kg

    height int32

    Package height in cm

    length int32

    Package length in cm

    width int32

    Package width in cm

    deliveryDetails

    object

    Delivery details

    estimatedDeliveryDate date

    Date of estimated delivery

    delay

    object

    Delivery delay details

    delayed boolean

    If delivery is delayed

    reason string

    The reason for the delay

    pin string

    PIN for pickup

    state

    object

    State of parcel

    delivery DeliveryState (string)

    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

    important ImportantState (string)deprecated

    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

    urgent UrgentState (string)deprecated

    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

    deliverToday boolean

    is parcel being delivered today?

    returning boolean

    is parcel returning back to sender?

    trackingState TrackingState (string)

    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

    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

    carrier Carrier (string)required

    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

    number string

    tracking number in carrier system

    url string

    url of tracking page in carrier system

    referenceId string

    optional id to reference parcel in carrier tracking system

    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

    type TimelineType (string)

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

    Type of timeline record

    text string

    Text of record

    created date-time

    moment in time when timeline record has been created

    author string

    author of record

    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: [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]

    event EmailEventType (string)

    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

    occurred date-time

    parcelState

    object

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

    delivery DeliveryState (string)

    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

    important ImportantState (string)deprecated

    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

    urgent UrgentState (string)deprecated

    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

    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)

    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

    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

    Possible values: [TRACKING_SUSPENDED]

    Optional tags assigned to parcel

    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

    updated date-time

    when was parcel last updated

  • ]

    • products

    object[]

    Products contained in this order

  • Array [

    • type ProductType (string)

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

    Type of product

    sku string

    product SKU

    name string

    name of product

    description string

    short product description.

    url string

    url of product detail.

    image string

    url of product image.

    price

    object

    amount of money in given currency

    amount numberrequired

    amount of money

    currency stringrequired

    currency of amount in ISO-4217 format

    vat number

    VAT value

    quantity int32

    Possible values: >= 1

    quantity ordered

    referencedSku string

    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

  • Array [

    • type ProductType (string)

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

    Type of product

    sku string

    product SKU

    name string

    name of product

    description string

    short product description.

    url string

    url of product detail.

    image string

    url of product image.

    price

    object

    amount of money in given currency

    amount numberrequired

    amount of money

    currency stringrequired

    currency of amount in ISO-4217 format

  • ]

    • 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?

    inImportantState boolean

    is order in important state?

    malfunction boolean

    is order in malfunction state?

    snooze

    object

    Snooze details

    until date-time

    moment in time until which order is snoozed

    author string

    author of snooze

    note string

    snooze note

    snoozed boolean

    is snooze currently active?

    created date-time

    moment in time when was order created

    updated date-time

    moment in time when was order last updated

    invoiceFileUrl string

    (Foxdeli storage) URL of the invoice that belongs to this order (optional)

    proformaInvoiceFileUrl string

    (Foxdeli storage) URL of the proforma invoice that belongs to this order (optional)

    links

    object

    required

    trackAndTrace

    object

    required

    link to a resource

    href string

    billingDetails

    object

    Billing details

    name string

    Name

    companyName string

    Company name

    billingAddress

    object

    Address details

    line1 string

    address line1

    line2 string

    address line2

    city string
    postalCode string
    countryCode CountryCode (string)

    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

    state string

    optional address state

    region string

    optional address region

    longitude double

    GPS longitude

    latitude double

    GPS latitude

    crn string

    Company Registration Number

    vatId string

    Value Added Tax Number

    email string

    Email address

    phone string

    Phone number

    language LanguageCode (string)

    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

  • Array [

    • name string

    link name

    url string

    link url

    icon ExternalLinkIcon (string)

    Possible values: [LINK, FILE]

    External Link Icon

  • ]

Loading...