shipstation-client

# TrackingStatusDetailCode The tracking status detail codes |Value |Description |:--------- |:----------------------------------------------------- | `COLLECTION_FAILED` | Shipment pickup failed. The delivery company will try again soon. | `AWAITING_DESPATCH` | Your shipment is ready to go and is waiting for pickup. | `COLLECTION_REQUESTED` | Your shipment pickup has been scheduled. | `DESPATCHED` | Your shipment has been handed over to the carrier or dropped off at collection point. It will soon start its journey. | `ELEC_ADVICE_RECD_BY_CARRIER` | Your shipment is now in the carrier\'s system. | `NOT_YET_RECEIVED_BY_CARRIER` | The sender couldn\'t hand over your shipment. The delivery company will try to collect it again. | `COLLECTION_MADE` | Your shipment has been picked up by the carrier. | `ATTEMPTED_DELIVERY` | Delivery attempt failed. Please check the carrier\'s instructions for next steps. | `ATTEMPTED_DELIVERY_2ND` | Second delivery attempt failed. Please check the carrier\'s instructions for next steps. | `ATTEMPTED_DELIVERY_3RD` | Third delivery attempt failed. Please check the carrier\'s instructions for next steps. | `COD_AMOUNT_NOT_PAID` | Delivery failed due to unpaid cash on delivery. Please check carrier instructions. | `COD_AMOUNT_PAID` | Cash on delivery payment received. | `CUSTOMER_CARDED` | Delivery attempt failed. Please check for delivery instructions left by the carrier. | `CUSTOMER_IDENTIFICATION_FAILED` | There was a recipient identification issue. Please check carrier instructions. | `INVALID_METHOD_OF_PAYMENT` | Delivery failed due to incorrect payment. Please check carrier instructions. | `NO_ACCESS_TO_RECIPIENTS_ADDRESS` | Delivery couldn\'t be completed due to issues with accessing address. Please follow carrier instructions. | `OUT_FOR_DELIVERY` | Your shipment is out for delivery. | `DELIVERED` | Your shipment has been delivered. | `DELIVERED_DAMAGED` | Your shipment was delivered but arrived damaged. | `DELIVERED_IN_PART` | Part of your shipment has been delivered. Check for updates on the rest. | `DELIVERED_SPECIFIED_SAFE_PLACE` | Your shipment has been left in your designated safe place. | `DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION` | Your shipment was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details. | `DELIVERED_TO_NEIGHBOUR` | Your shipment was delivered to your neighbor. | `DELIVERED_TO_PO_BOX` | Your shipment was delivered to your PO Box. | `PARCEL_COLLECTED_FROM_PICKUP_POINT` | Your package has been picked up from the collection point. | `POST_TRANSIT_STATUS` | The carrier has added more information about your delivery. | `PROOF_OF_DELIVERY` | Delivery confirmed. | `CANCELLED` | Your shipment has been cancelled. | `CANCELLED_BEFORE_DESPATCH` | Your shipment was cancelled before pickup. Contact the sender if unexpected. | `CUSTOMER_MOVED` | Recipient not at address. Your shipment is being returned. | `HAZARDOUS_PROHIBITED` | Your parcel contained a prohibited item and is being returned. Contact the sender. | `NOT_COLLECTED_FROM_PICKUP_POINT` | Shipment not collected from the pickup point. Your parcel is being returned to the sender. | `NOT_DELIVERED` | Delivery attempts failed. Your parcel is being returned to the sender. | `NOT_DELIVERED_ADDRESSEE_DECEASED` | Delivery not possible due to recipient\'s passing. | `PARCEL_DAMAGED` | Your parcel was damaged and can\'t be delivered. It\'s being returned. Contact the sender. | `PARCEL_DISPOSED` | Shipment was disposed of. Contact the sender for details. | `PARCEL_LOST` | Your parcel is lost. Contact the sender for next steps. | `PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY` | Shipment is too large/heavy for delivery. Being returned. Contact sender. | `REFUSED_BY_CUSTOMER` | Delivery refused. Shipment being returned. Contact the sender. | `RETURN_TO_SENDER` | Your shipment is being returned to the sender. Contact them for details. | `ADDRESS_QUERY` | There\'s an issue with your delivery address. This may cause a delay or return. Contact sender or carrier. | `CARRIER_DELAYS` | There\'s a delivery delay. We\'ll update you when there\'s more info. | `CUSTOMS_CLEARED` | Your shipment has passed customs clearance. | `CUSTOMS_PROCESSING` | Your shipment is going through customs. | `DELAYED_NOT_CARRIER` | Unexpected delivery delay. We\'ll update you soon. | `DELIVERY_ARRANGED_WITH_RECIPIENT` | Delivery arranged by recipient. | `HELD_BY_CARRIER` | Your shipment is on hold due to a carrier issue. We\'ll update you soon. | `HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING` | Your shipment is held by carrier due to customs issues. We\'ll update you. | `HELD_BY_CUSTOMS` | Your shipment is held in customs. We\'ll update you. | `HELD_BY_EXPORT_CUSTOMS` | Your shipment is held in export customs. We\'ll update you. | `HELD_BY_IMPORT_CUSTOMS` | Your shipment is held in import customs. We\'ll update you. | `HUB_SCAN_OUT` | Your shipment is at the main delivery depot. | `IN_TRANSIT` | Your shipment is on its way between depots. | `INCORRECT_DECLARATION` | Incorrect shipment dimensions. Delivery may be delayed or returned. We\'ll update you. | `INFORMATION` | The carrier has shared additional shipment information. | `MISSORTED` | Your shipment was missorted. There might be a delivery delay. We\'ll update you. | `PARCEL_OVER_LABELLED` | Your shipment was over labelled by the delivery company to improve processing. | `PARCEL_REPACKED` | Your shipment packaging was damaged. It\'s being repacked. This might delay delivery. | `PARCEL_UPDATE_NOTIFICATION_VIA_EMAIL` | You\'ve received an email with a shipment update. | `PARCEL_UPDATE_NOTIFICATION_VIA_SMS` | You\'ve received a text message with a shipment update. | `RECEIVED_BY_CARRIER` | Your shipment has been received by the carrier. | `RECEIVED_LOCAL_DELIVERY_DEPOT` | Your shipment is at the local delivery depot, ready for delivery. | `ROUTING_ERROR` | Your shipment was sent to the wrong place. There might be a delay. | `SUB_CONTRACTOR_EVENT` | Your shipment is with the local delivery partner. | `SUB_CONTRACTOR_RECEIVED` | Your shipment has been received by the local delivery partner. | `RECD_BY_CARRIER_NO_ELEC_ADVICE` | There\'s a system issue with your shipment. Tracking updates might be delayed. | `AWAITING_ELECTRONIC_ADVICE` | Your tracking number is ready. Your shipment is waiting to be registered in the carrier system and scheduled for pickup. | `AWAITING_COLLECTION_FROM_PICKUP_POINT` | Your shipment is ready for pickup at the specified location. | `COLLECT_AT_LOCAL_PO` | Your shipment has been redirected to the local post office for pickup. Check carrier instructions. | `CUSTOMER_TO_COLLECT_FROM_CARRIER` | Your shipment is being held for pickup. Check carrier instructions. | `DELIVERED_TO_LOCKER_COLLECTION_POINT` | Your shipment has been delivered to your locker. | `CARRIER_STATUS_NOT_MAPPED` | Status not mapped. Please check the carrier\'s website for updates. ## Enum * `CollectionFailed` (value: `'COLLECTION_FAILED'`) * `AwaitingDespatch` (value: `'AWAITING_DESPATCH'`) * `CollectionRequested` (value: `'COLLECTION_REQUESTED'`) * `Despatched` (value: `'DESPATCHED'`) * `ElecAdviceRecdByCarrier` (value: `'ELEC_ADVICE_RECD_BY_CARRIER'`) * `NotYetReceivedByCarrier` (value: `'NOT_YET_RECEIVED_BY_CARRIER'`) * `CollectionMade` (value: `'COLLECTION_MADE'`) * `AttemptedDelivery` (value: `'ATTEMPTED_DELIVERY'`) * `AttemptedDelivery2Nd` (value: `'ATTEMPTED_DELIVERY_2ND'`) * `AttemptedDelivery3Rd` (value: `'ATTEMPTED_DELIVERY_3RD'`) * `CodAmountNotPaid` (value: `'COD_AMOUNT_NOT_PAID'`) * `CodAmountPaid` (value: `'COD_AMOUNT_PAID'`) * `CustomerCarded` (value: `'CUSTOMER_CARDED'`) * `CustomerIdentificationFailed` (value: `'CUSTOMER_IDENTIFICATION_FAILED'`) * `InvalidMethodOfPayment` (value: `'INVALID_METHOD_OF_PAYMENT'`) * `NoAccessToRecipientsAddress` (value: `'NO_ACCESS_TO_RECIPIENTS_ADDRESS'`) * `OutForDelivery` (value: `'OUT_FOR_DELIVERY'`) * `Delivered` (value: `'DELIVERED'`) * `DeliveredDamaged` (value: `'DELIVERED_DAMAGED'`) * `DeliveredInPart` (value: `'DELIVERED_IN_PART'`) * `DeliveredSpecifiedSafePlace` (value: `'DELIVERED_SPECIFIED_SAFE_PLACE'`) * `DeliveredToAlternativeDeliveryLocation` (value: `'DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION'`) * `DeliveredToNeighbour` (value: `'DELIVERED_TO_NEIGHBOUR'`) * `DeliveredToPoBox` (value: `'DELIVERED_TO_PO_BOX'`) * `ParcelCollectedFromPickupPoint` (value: `'PARCEL_COLLECTED_FROM_PICKUP_POINT'`) * `PostTransitStatus` (value: `'POST_TRANSIT_STATUS'`) * `ProofOfDelivery` (value: `'PROOF_OF_DELIVERY'`) * `Cancelled` (value: `'CANCELLED'`) * `CancelledBeforeDespatch` (value: `'CANCELLED_BEFORE_DESPATCH'`) * `CustomerMoved` (value: `'CUSTOMER_MOVED'`) * `HazardousProhibited` (value: `'HAZARDOUS_PROHIBITED'`) * `NotCollectedFromPickupPoint` (value: `'NOT_COLLECTED_FROM_PICKUP_POINT'`) * `NotDelivered` (value: `'NOT_DELIVERED'`) * `NotDeliveredAddresseeDeceased` (value: `'NOT_DELIVERED_ADDRESSEE_DECEASED'`) * `ParcelDamaged` (value: `'PARCEL_DAMAGED'`) * `ParcelDisposed` (value: `'PARCEL_DISPOSED'`) * `ParcelLost` (value: `'PARCEL_LOST'`) * `ParcelOutsideOfServiceCapability` (value: `'PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY'`) * `RefusedByCustomer` (value: `'REFUSED_BY_CUSTOMER'`) * `ReturnToSender` (value: `'RETURN_TO_SENDER'`) * `AddressQuery` (value: `'ADDRESS_QUERY'`) * `CarrierDelays` (value: `'CARRIER_DELAYS'`) * `CustomsCleared` (value: `'CUSTOMS_CLEARED'`) * `CustomsProcessing` (value: `'CUSTOMS_PROCESSING'`) * `DelayedNotCarrier` (value: `'DELAYED_NOT_CARRIER'`) * `DeliveryArrangedWithRecipient` (value: `'DELIVERY_ARRANGED_WITH_RECIPIENT'`) * `HeldByCarrier` (value: `'HELD_BY_CARRIER'`) * `HeldByCarrierForClearancePreProcessing` (value: `'HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING'`) * `HeldByCustoms` (value: `'HELD_BY_CUSTOMS'`) * `HeldByExportCustoms` (value: `'HELD_BY_EXPORT_CUSTOMS'`) * `HeldByImportCustoms` (value: `'HELD_BY_IMPORT_CUSTOMS'`) * `HubScanOut` (value: `'HUB_SCAN_OUT'`) * `InTransit` (value: `'IN_TRANSIT'`) * `IncorrectDeclaration` (value: `'INCORRECT_DECLARATION'`) * `Information` (value: `'INFORMATION'`) * `Missorted` (value: `'MISSORTED'`) * `ParcelOverLabelled` (value: `'PARCEL_OVER_LABELLED'`) * `ParcelRepacked` (value: `'PARCEL_REPACKED'`) * `ParcelUpdateNotificationViaEmail` (value: `'PARCEL_UPDATE_NOTIFICATION_VIA_EMAIL'`) * `ParcelUpdateNotificationViaSms` (value: `'PARCEL_UPDATE_NOTIFICATION_VIA_SMS'`) * `ReceivedByCarrier` (value: `'RECEIVED_BY_CARRIER'`) * `ReceivedLocalDeliveryDepot` (value: `'RECEIVED_LOCAL_DELIVERY_DEPOT'`) * `RoutingError` (value: `'ROUTING_ERROR'`) * `SubContractorEvent` (value: `'SUB_CONTRACTOR_EVENT'`) * `SubContractorReceived` (value: `'SUB_CONTRACTOR_RECEIVED'`) * `RecdByCarrierNoElecAdvice` (value: `'RECD_BY_CARRIER_NO_ELEC_ADVICE'`) * `AwaitingElectronicAdvice` (value: `'AWAITING_ELECTRONIC_ADVICE'`) * `AwaitingCollectionFromPickupPoint` (value: `'AWAITING_COLLECTION_FROM_PICKUP_POINT'`) * `CollectAtLocalPo` (value: `'COLLECT_AT_LOCAL_PO'`) * `CustomerToCollectFromCarrier` (value: `'CUSTOMER_TO_COLLECT_FROM_CARRIER'`) * `DeliveredToLockerCollectionPoint` (value: `'DELIVERED_TO_LOCKER_COLLECTION_POINT'`) * `CarrierStatusNotMapped` (value: `'CARRIER_STATUS_NOT_MAPPED'`) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)