shipstation-client
Version:
ShipStation V2 SDK
92 lines (91 loc) • 11.8 kB
TypeScript
/**
* ShipStation API v2
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 2.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* 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.
* @export
* @enum {string}
*/
export declare const TrackingStatusDetailCode: {
readonly CollectionFailed: "COLLECTION_FAILED";
readonly AwaitingDespatch: "AWAITING_DESPATCH";
readonly CollectionRequested: "COLLECTION_REQUESTED";
readonly Despatched: "DESPATCHED";
readonly ElecAdviceRecdByCarrier: "ELEC_ADVICE_RECD_BY_CARRIER";
readonly NotYetReceivedByCarrier: "NOT_YET_RECEIVED_BY_CARRIER";
readonly CollectionMade: "COLLECTION_MADE";
readonly AttemptedDelivery: "ATTEMPTED_DELIVERY";
readonly AttemptedDelivery2Nd: "ATTEMPTED_DELIVERY_2ND";
readonly AttemptedDelivery3Rd: "ATTEMPTED_DELIVERY_3RD";
readonly CodAmountNotPaid: "COD_AMOUNT_NOT_PAID";
readonly CodAmountPaid: "COD_AMOUNT_PAID";
readonly CustomerCarded: "CUSTOMER_CARDED";
readonly CustomerIdentificationFailed: "CUSTOMER_IDENTIFICATION_FAILED";
readonly InvalidMethodOfPayment: "INVALID_METHOD_OF_PAYMENT";
readonly NoAccessToRecipientsAddress: "NO_ACCESS_TO_RECIPIENTS_ADDRESS";
readonly OutForDelivery: "OUT_FOR_DELIVERY";
readonly Delivered: "DELIVERED";
readonly DeliveredDamaged: "DELIVERED_DAMAGED";
readonly DeliveredInPart: "DELIVERED_IN_PART";
readonly DeliveredSpecifiedSafePlace: "DELIVERED_SPECIFIED_SAFE_PLACE";
readonly DeliveredToAlternativeDeliveryLocation: "DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION";
readonly DeliveredToNeighbour: "DELIVERED_TO_NEIGHBOUR";
readonly DeliveredToPoBox: "DELIVERED_TO_PO_BOX";
readonly ParcelCollectedFromPickupPoint: "PARCEL_COLLECTED_FROM_PICKUP_POINT";
readonly PostTransitStatus: "POST_TRANSIT_STATUS";
readonly ProofOfDelivery: "PROOF_OF_DELIVERY";
readonly Cancelled: "CANCELLED";
readonly CancelledBeforeDespatch: "CANCELLED_BEFORE_DESPATCH";
readonly CustomerMoved: "CUSTOMER_MOVED";
readonly HazardousProhibited: "HAZARDOUS_PROHIBITED";
readonly NotCollectedFromPickupPoint: "NOT_COLLECTED_FROM_PICKUP_POINT";
readonly NotDelivered: "NOT_DELIVERED";
readonly NotDeliveredAddresseeDeceased: "NOT_DELIVERED_ADDRESSEE_DECEASED";
readonly ParcelDamaged: "PARCEL_DAMAGED";
readonly ParcelDisposed: "PARCEL_DISPOSED";
readonly ParcelLost: "PARCEL_LOST";
readonly ParcelOutsideOfServiceCapability: "PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY";
readonly RefusedByCustomer: "REFUSED_BY_CUSTOMER";
readonly ReturnToSender: "RETURN_TO_SENDER";
readonly AddressQuery: "ADDRESS_QUERY";
readonly CarrierDelays: "CARRIER_DELAYS";
readonly CustomsCleared: "CUSTOMS_CLEARED";
readonly CustomsProcessing: "CUSTOMS_PROCESSING";
readonly DelayedNotCarrier: "DELAYED_NOT_CARRIER";
readonly DeliveryArrangedWithRecipient: "DELIVERY_ARRANGED_WITH_RECIPIENT";
readonly HeldByCarrier: "HELD_BY_CARRIER";
readonly HeldByCarrierForClearancePreProcessing: "HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING";
readonly HeldByCustoms: "HELD_BY_CUSTOMS";
readonly HeldByExportCustoms: "HELD_BY_EXPORT_CUSTOMS";
readonly HeldByImportCustoms: "HELD_BY_IMPORT_CUSTOMS";
readonly HubScanOut: "HUB_SCAN_OUT";
readonly InTransit: "IN_TRANSIT";
readonly IncorrectDeclaration: "INCORRECT_DECLARATION";
readonly Information: "INFORMATION";
readonly Missorted: "MISSORTED";
readonly ParcelOverLabelled: "PARCEL_OVER_LABELLED";
readonly ParcelRepacked: "PARCEL_REPACKED";
readonly ParcelUpdateNotificationViaEmail: "PARCEL_UPDATE_NOTIFICATION_VIA_EMAIL";
readonly ParcelUpdateNotificationViaSms: "PARCEL_UPDATE_NOTIFICATION_VIA_SMS";
readonly ReceivedByCarrier: "RECEIVED_BY_CARRIER";
readonly ReceivedLocalDeliveryDepot: "RECEIVED_LOCAL_DELIVERY_DEPOT";
readonly RoutingError: "ROUTING_ERROR";
readonly SubContractorEvent: "SUB_CONTRACTOR_EVENT";
readonly SubContractorReceived: "SUB_CONTRACTOR_RECEIVED";
readonly RecdByCarrierNoElecAdvice: "RECD_BY_CARRIER_NO_ELEC_ADVICE";
readonly AwaitingElectronicAdvice: "AWAITING_ELECTRONIC_ADVICE";
readonly AwaitingCollectionFromPickupPoint: "AWAITING_COLLECTION_FROM_PICKUP_POINT";
readonly CollectAtLocalPo: "COLLECT_AT_LOCAL_PO";
readonly CustomerToCollectFromCarrier: "CUSTOMER_TO_COLLECT_FROM_CARRIER";
readonly DeliveredToLockerCollectionPoint: "DELIVERED_TO_LOCKER_COLLECTION_POINT";
readonly CarrierStatusNotMapped: "CARRIER_STATUS_NOT_MAPPED";
};
export type TrackingStatusDetailCode = typeof TrackingStatusDetailCode[keyof typeof TrackingStatusDetailCode];