Skip to main content

Update state of existing parcel

PUT 
/api/v1/order/:orderId/parcel/:parcelId/state

Updates state of existing parcel

Request​

Path Parameters

    orderId stringrequired

    id of order this parcel belongs to

    parcelId stringrequired

    id of parcel to update.

Body

required

Parcel data to update.

    state DeliveryStateRequest (string)required

    State of delivery of parcel

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

    Example: CANCELLED
    occurred date-time

    optional moment in time when this change happened. ISO 8601, format: YYYY-MM-DDThh:mm:ss.sssZ

    note string

    optional note describing the state change

Responses​

Parcel state successfully updated.

Schema

    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
Loading...