Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Refuse an uploaded label with no tracking number at compile time

Damian Legawiec49d12591ac3b
diff --git a/packages/admin-sdk/src/params.ts b/packages/admin-sdk/src/params.ts
index ebc5ad58be..697e1f4c31 100644
--- a/packages/admin-sdk/src/params.ts
+++ b/packages/admin-sdk/src/params.ts
@@ -280,12 +280,8 @@ export interface FulfillmentFulfillParams {
force?: boolean
}
-/** Buying a label takes no body; recording an uploaded one takes at least a file and a number. */
-export interface ShippingLabelCreateParams {
- /** Signed blob id from `directUploads.create()`. Its presence records an uploaded label instead of buying one. */
- file?: string
- /** The number printed on an uploaded label. */
- tracking_number?: string
+/** What a label records, whether it was bought or uploaded. */
+interface ShippingLabelDetails {
/** Free text — a forwarder's name is as valid as a carrier slug. Detected from the number when omitted. */
carrier?: string
/** Carrier service the label was bought at. */
@@ -300,6 +296,27 @@ export interface ShippingLabelCreateParams {
tracking_url?: string
}
+/**
+ * Recording a label bought elsewhere. The number printed on it is required:
+ * a label with no tracking number mints no consignment, and the server
+ * refuses it.
+ */
+export interface ShippingLabelUploadParams extends ShippingLabelDetails {
+ /** Signed blob id from `directUploads.create()`. Its presence records an uploaded label instead of buying one. */
+ file: string
+ /** The number printed on an uploaded label. */
+ tracking_number: string
+}
+
+/** Buying through the carrier. The carrier supplies the file and the number. */
+export interface ShippingLabelPurchaseParams extends ShippingLabelDetails {
+ file?: never
+ tracking_number?: never
+}
+
+/** Buying a label takes no body; recording an uploaded one takes at least a file and a number. */
+export type ShippingLabelCreateParams = ShippingLabelUploadParams | ShippingLabelPurchaseParams
+
export interface DeliveryCreateParams {
/** A carrier tracking number, a freight PRO or container number, or a full tracking link. */
tracking_number: string