HomeGuidesAPI ReferenceChangelogSupport Request
Guides

Cancel Order Package Item (updatePackage)

Cancel Order Package Item

You can use this method to cancel one or more item in Order Package.

  • Each order package has a shipmentPackageId value. If one of the item is cancelled in the package, the package will be split automatically and new shipmentPackageId will be generated and assigned to the new package.
flowchart LR

A["Seller updates status to **Picking** (putUpdatePackage)"]
B["Seller updates status to **Invoiced** (optional) (putUpdatePackage)"]
C["Shipment is completed with existing **shipmentPackageId** and **cargoTrackingNumber** (getShipmentPackages)"]
D{"Will it be cancelled due to out of stock? (**shipmentpackageId**)"}
E["Package is created"]
F["A cancellation request is made for the entire package (putUpdatePackage)"]
G["Package status becomes **Cancelled**. You can see order via **getShipmentpackage** service or **Webhook** model (getShipmentPackages)"]
H{"Will the entire order be cancelled? (**shipmentpackageId**)"}
I["A partial cancellation request is made for the package (putUpdatePackage)"]
J["The current shipment package id gets invalid and its status is updated to **Cancelled**"]
K["New **shipmentpackageid** and **cargoTrackingNumber** are generated under the same **ordernumber** (getShipmentPackages)"]
L["New package details are retrieved from **getShipmentPackage** service or checked via **Webhook** model (getShipmentPackages)"]

D -->|NO| A
D -->|YES| H
I --> J
J --> K
K --> L
F --> G
E --> D
A --> B
B --> C
H -->|YES| F
H -->|NO| I
L --> D

classDef style0 fill:#ffe6cc,stroke:#d79b00,stroke-width:2px
classDef style1 fill:#d5e8d4,stroke:#82b366,stroke-width:2px
class A,B,C,E,F,G,I,J,K,L style0
class D,H style1

PUT updatePackage

Sample Service Request

{
 "lines": [
   {
     "lineId": 0,
     "quantity": 0
   }
 ],
"reasonId":0
 }

Cancellation Reasons

reasonIdnamedescription
500Stock OutIt should be selected if the product cannot be supplied due to out of stock and delay in shipping.
501Defective ProductIf the product cannot be sent because it is defective, it should be selected.
502Incorrect PriceIt should be selected in case of feeding the wrong price.
504Integration ProblemIt should be selected in case of problems experienced in incorrect price or stock transfer due to the integration company.
505Bulk purchaseIt should be chosen if it is purchased from a single product and in bulk by the same customer after the discount on the product.
506Force MajeureNatural disaster, illness, funeral, etc. should be chosen in cases