Skip to main content

Class: OrdersService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:21

Extends​

  • BaseService

Constructors​

Constructor​

new OrdersService(client): OrdersService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:33

Parameters​

client​

TanqoryClient

Returns​

OrdersService

Overrides​

BaseService.constructor

Properties​

client​

protected client: TanqoryClient

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:10

Inherited from​

BaseService.client

Methods​

addCustomItemToOrderEdit()​

addCustomItemToOrderEdit(...args): Promise<OrderEditWithDetails>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:677

Parameters​

args​

...[string, string, AddCustomItemToOrderEditInput]

Returns​

Promise<OrderEditWithDetails>

addDraftOrderTimelineComment()​

addDraftOrderTimelineComment(...args): Promise<DraftOrderTimeline>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:853

Parameters​

args​

...[string, string, string, object[], object[]]

Returns​

Promise<DraftOrderTimeline>

addFulfillmentEvent()​

addFulfillmentEvent(...args): Promise<{ createdAt: Date; id: string; items: object[]; status: "partial" | "fulfilled" | "unfulfilled"; trackingInfo?: { company?: string; number: string; url?: string; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:495

Parameters​

args​

...[string, string, string, AddFulfillmentEventInput]

Returns​

Promise<{ createdAt: Date; id: string; items: object[]; status: "partial" | "fulfilled" | "unfulfilled"; trackingInfo?: { company?: string; number: string; url?: string; }; }>

addNote()​

addNote(...args): Promise<{ author?: string; createdAt: Date; id: string; note: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:190

Parameters​

args​

...[string, object, string]

Returns​

Promise<{ author?: string; createdAt: Date; id: string; note: string; }>

addOrderEditDiscount()​

addOrderEditDiscount(...args): Promise<OrderEditWithDetails>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:695

Parameters​

args​

...[string, string, AddOrderEditDiscountInput]

Returns​

Promise<OrderEditWithDetails>

addTimelineComment()​

addTimelineComment(...args): Promise<{ attachments?: object[]; authorId?: string; authorName?: string; createdAt: Date; description?: string; editedAt?: Date; id: string; isComment: boolean; isEdited: boolean; isSystem: boolean; mentions?: object[]; metadata?: Record<string, unknown>; timestamp: Date; title: string; type: "NOTIFICATION_SENT" | "NOTIFICATION_FAILED" | "NOTIFICATION_RESENT" | "TRACKING_ADDED" | "TRACKING_UPDATED" | "NOTE_ADDED" | "COMMENT" | "SHIPMENT_CREATED" | "ORDER_CANCELLED" | "ORDER_EDITED" | "REFUND_ISSUED" | "DELIVERED" | "ORDER_CREATED" | "ORDER_CONFIRMED" | "CONFIRMATION_GENERATED" | "ORDER_CLOSED" | "ORDER_REOPENED" | "ORDER_ARCHIVED" | "ORDER_UNARCHIVED" | "PAYMENT_CAPTURED" | "PAYMENT_FAILED" | "PAYMENT_PENDING" | "AUTHORIZATION_SUCCESS" | "AUTHORIZATION_PENDING" | "AUTHORIZATION_FAILURE" | "AUTHORIZATION_EXPIRED" | "VOID_SUCCESS" | "VOID_PENDING" | "VOID_FAILURE" | "SALE_SUCCESS" | "SALE_PENDING" | "SALE_FAILURE" | "FULFILLMENT_CREATED" | "FULFILLMENT_IN_PROGRESS" | "FULFILLMENT_UNFULFILLED" | "FULFILLMENT_HOLD" | "FULFILLMENT_RELEASED" | "FULFILLMENT_RELEASED_STATUS" | "FULFILLMENT_RESCHEDULED" | "FULFILLMENT_MOVED" | "FULFILLMENT_SPLIT" | "FULFILLMENT_MERGED" | "GIFT_CARD_FULFILLED" | "FULFILLMENT_CANCELLED" | "FULFILLMENT_PENDING" | "RESTOCK_LINE_ITEMS" | "REFUND_CREATED" | "REFUND_PROCESSED" | "REFUND_PENDING" | "REFUND_FAILED" | "RETURN_CREATED" | "RETURN_TRACKING_ADDED" | "RETURN_TRACKING_UPDATED" | "RETURN_LABEL_UPLOADED" | "RETURN_LABEL_REMOVED" | "RETURN_DECLINED" | "RETURN_CANCELLED" | "RETURN_ITEMS_RECEIVED" | "RETURN_PROCESSED" | "RETURN_CLOSED" | "RETURN_REOPENED" | "TRACKING_REMOVED" | "RISK_ASSESSED"; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:221

Parameters​

args​

...[string, AddTimelineCommentRequest, string]

Returns​

Promise<{ attachments?: object[]; authorId?: string; authorName?: string; createdAt: Date; description?: string; editedAt?: Date; id: string; isComment: boolean; isEdited: boolean; isSystem: boolean; mentions?: object[]; metadata?: Record<string, unknown>; timestamp: Date; title: string; type: "NOTIFICATION_SENT" | "NOTIFICATION_FAILED" | "NOTIFICATION_RESENT" | "TRACKING_ADDED" | "TRACKING_UPDATED" | "NOTE_ADDED" | "COMMENT" | "SHIPMENT_CREATED" | "ORDER_CANCELLED" | "ORDER_EDITED" | "REFUND_ISSUED" | "DELIVERED" | "ORDER_CREATED" | "ORDER_CONFIRMED" | "CONFIRMATION_GENERATED" | "ORDER_CLOSED" | "ORDER_REOPENED" | "ORDER_ARCHIVED" | "ORDER_UNARCHIVED" | "PAYMENT_CAPTURED" | "PAYMENT_FAILED" | "PAYMENT_PENDING" | "AUTHORIZATION_SUCCESS" | "AUTHORIZATION_PENDING" | "AUTHORIZATION_FAILURE" | "AUTHORIZATION_EXPIRED" | "VOID_SUCCESS" | "VOID_PENDING" | "VOID_FAILURE" | "SALE_SUCCESS" | "SALE_PENDING" | "SALE_FAILURE" | "FULFILLMENT_CREATED" | "FULFILLMENT_IN_PROGRESS" | "FULFILLMENT_UNFULFILLED" | "FULFILLMENT_HOLD" | "FULFILLMENT_RELEASED" | "FULFILLMENT_RELEASED_STATUS" | "FULFILLMENT_RESCHEDULED" | "FULFILLMENT_MOVED" | "FULFILLMENT_SPLIT" | "FULFILLMENT_MERGED" | "GIFT_CARD_FULFILLED" | "FULFILLMENT_CANCELLED" | "FULFILLMENT_PENDING" | "RESTOCK_LINE_ITEMS" | "REFUND_CREATED" | "REFUND_PROCESSED" | "REFUND_PENDING" | "REFUND_FAILED" | "RETURN_CREATED" | "RETURN_TRACKING_ADDED" | "RETURN_TRACKING_UPDATED" | "RETURN_LABEL_UPLOADED" | "RETURN_LABEL_REMOVED" | "RETURN_DECLINED" | "RETURN_CANCELLED" | "RETURN_ITEMS_RECEIVED" | "RETURN_PROCESSED" | "RETURN_CLOSED" | "RETURN_REOPENED" | "TRACKING_REMOVED" | "RISK_ASSESSED"; }>

addTracking()​

addTracking(...args): Promise<{ carrierId?: string; carrierInfo?: { alias?: string; country?: string; homepage?: string; key: number; name: string; }; createdAt: Date; daysInTransit?: number; deliveredAt?: Date; estimatedDeliveryAt?: Date; events?: object[]; fulfillmentId: string; id: string; lastTrackingSync?: Date; milestones?: object[]; registeredAt?: Date; registrationError?: string; registrationStatus: "PENDING" | "EXPIRED" | "FAILED" | "ACTIVE" | "REGISTERED"; shipmentStatus: "PENDING" | "EXPIRED" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "INFO_RECEIVED" | "FAILED_ATTEMPT" | "EXCEPTION" | "RETURNED_TO_SENDER"; shippedAt?: Date; shippingInfo?: { recipientAddress?: { city?: string; coordinates?: { latitude?: number; longitude?: number; }; country?: string; postalCode?: string; state?: string; street?: string; }; shipperAddress?: { city?: string; coordinates?: { latitude?: number; longitude?: number; }; country?: string; postalCode?: string; state?: string; street?: string; }; }; storeId: string; syncCount: number; timeMetrics?: { daysAfterLastUpdate?: number; daysAfterOrder?: number; daysOfTransit?: number; daysOfTransitDone?: number; estimatedDeliveryDate?: { from?: Date; source?: string; to?: Date; }; }; trackingCompany?: string; trackingNumber: string; trackingSource?: string; trackingUrl?: string; updatedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:453

Parameters​

args​

...[string, string, string, object]

Returns​

Promise<{ carrierId?: string; carrierInfo?: { alias?: string; country?: string; homepage?: string; key: number; name: string; }; createdAt: Date; daysInTransit?: number; deliveredAt?: Date; estimatedDeliveryAt?: Date; events?: object[]; fulfillmentId: string; id: string; lastTrackingSync?: Date; milestones?: object[]; registeredAt?: Date; registrationError?: string; registrationStatus: "PENDING" | "EXPIRED" | "FAILED" | "ACTIVE" | "REGISTERED"; shipmentStatus: "PENDING" | "EXPIRED" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "INFO_RECEIVED" | "FAILED_ATTEMPT" | "EXCEPTION" | "RETURNED_TO_SENDER"; shippedAt?: Date; shippingInfo?: { recipientAddress?: { city?: string; coordinates?: { latitude?: number; longitude?: number; }; country?: string; postalCode?: string; state?: string; street?: string; }; shipperAddress?: { city?: string; coordinates?: { latitude?: number; longitude?: number; }; country?: string; postalCode?: string; state?: string; street?: string; }; }; storeId: string; syncCount: number; timeMetrics?: { daysAfterLastUpdate?: number; daysAfterOrder?: number; daysOfTransit?: number; daysOfTransitDone?: number; estimatedDeliveryDate?: { from?: Date; source?: string; to?: Date; }; }; trackingCompany?: string; trackingNumber: string; trackingSource?: string; trackingUrl?: string; updatedAt: Date; }>

addVariantToOrderEdit()​

addVariantToOrderEdit(...args): Promise<OrderEditWithDetails>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:671

Parameters​

args​

...[string, string, AddVariantToOrderEditInput]

Returns​

Promise<OrderEditWithDetails>

applyOrderEdit()​

applyOrderEdit(...args): Promise<{ balanceAction: "NONE" | "REFUND" | "COLLECT"; balanceAmount: number; changes: { discountsApplied: number; itemsAdded: number; lineItemsModified: number; }; order: { discountTotal: number; id: string; name: string; orderNumber: number; shippingTotal: number; subtotal: number; taxTotal: number; total: number; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:719

Parameters​

args​

...[string, string, object]

Returns​

Promise<{ balanceAction: "NONE" | "REFUND" | "COLLECT"; balanceAmount: number; changes: { discountsApplied: number; itemsAdded: number; lineItemsModified: number; }; order: { discountTotal: number; id: string; name: string; orderNumber: number; shippingTotal: number; subtotal: number; taxTotal: number; total: number; }; }>

approveReturn()​

approveReturn(...args): Promise<ReturnWithDetails>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:544

Parameters​

args​

...[string, string, ApproveReturnInput]

Returns​

Promise<ReturnWithDetails>

archive()​

archive(...args): Promise<{ appliedDiscount?: { amount?: number; description?: string; title?: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes?: object[]; archivedAt?: Date; authorizedAmount?: number; autoApplyDiscounts?: boolean; billingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; cancelledAt?: Date; cancelledBy?: string; cancelledByName?: string; cancelNote?: string; cancelReason?: string; capturedAmount?: number; cartDiscountAmount: number; channel?: string; closedAt?: Date; completedAt?: Date; createdAt: Date; currency: string; currentCartDiscountAmount: number; currentSubtotal?: number; currentSubtotalLineItemsQuantity?: number; currentTotalDiscounts: number; currentTotalPrice?: number; currentTotalTax?: number; customer?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; deliveryStatus?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; discountApplications?: object[]; discountCodes: string[]; dutiesRefundedAmount?: number; edited?: boolean; editedAt?: Date; email?: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed?: number; fulfilledAt?: Date; fulfillmentStatus: "SCHEDULED" | "UNFULFILLED" | "PARTIALLY_FULFILLED" | "FULFILLED" | "ON_HOLD"; giftCardAmountApplied?: number; giftCardCode?: string; giftCardsGenerated?: object[]; id: string; items: object[]; marketId?: string; netPayment?: number; notes?: string; orderNumber: string | number; paidAt?: Date; payment?: { amountPaid: number; amountRefunded: number; codeDiscount?: number; currency: string; discount: number; lineItemDiscount?: number; shipping: number; shippingBeforeDiscount?: number; shippingDiscount?: number; subtotal: number; tax: number; taxRate: number; total: number; totalPriceInStoreCurrency?: number; }; paymentMethod?: string; paymentStatus: "PENDING" | "EXPIRED" | "FAILED" | "REFUNDED" | "AUTHORIZED" | "PARTIALLY_PAID" | "PAID" | "CAPTURED" | "VOIDED" | "PARTIALLY_REFUNDED"; phone?: string; presentmentCurrency?: string; riskLevel?: "LOW" | "MEDIUM" | "HIGH"; riskScore?: number; shipping?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; carrier?: string; method: "NONE" | "SHIPPING" | "PICK_UP" | "LOCAL_DELIVERY" | "RETAIL"; shippingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; status?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; trackingNumber?: string; trackingUrl?: string; }; shippingRefundedAmount?: number; status: "PENDING" | "PROCESSING" | "COMPLETED" | "CANCELLED" | "CONFIRMED" | "SHIPPED" | "DELIVERED" | "REFUNDED"; storeId?: string; tags?: string[]; timeline?: object[]; totalOutstanding?: number; totalReceived?: number; totalRefunded?: number; updatedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:100

Parameters​

args​

...[string, string]

Returns​

Promise<{ appliedDiscount?: { amount?: number; description?: string; title?: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes?: object[]; archivedAt?: Date; authorizedAmount?: number; autoApplyDiscounts?: boolean; billingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; cancelledAt?: Date; cancelledBy?: string; cancelledByName?: string; cancelNote?: string; cancelReason?: string; capturedAmount?: number; cartDiscountAmount: number; channel?: string; closedAt?: Date; completedAt?: Date; createdAt: Date; currency: string; currentCartDiscountAmount: number; currentSubtotal?: number; currentSubtotalLineItemsQuantity?: number; currentTotalDiscounts: number; currentTotalPrice?: number; currentTotalTax?: number; customer?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; deliveryStatus?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; discountApplications?: object[]; discountCodes: string[]; dutiesRefundedAmount?: number; edited?: boolean; editedAt?: Date; email?: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed?: number; fulfilledAt?: Date; fulfillmentStatus: "SCHEDULED" | "UNFULFILLED" | "PARTIALLY_FULFILLED" | "FULFILLED" | "ON_HOLD"; giftCardAmountApplied?: number; giftCardCode?: string; giftCardsGenerated?: object[]; id: string; items: object[]; marketId?: string; netPayment?: number; notes?: string; orderNumber: string | number; paidAt?: Date; payment?: { amountPaid: number; amountRefunded: number; codeDiscount?: number; currency: string; discount: number; lineItemDiscount?: number; shipping: number; shippingBeforeDiscount?: number; shippingDiscount?: number; subtotal: number; tax: number; taxRate: number; total: number; totalPriceInStoreCurrency?: number; }; paymentMethod?: string; paymentStatus: "PENDING" | "EXPIRED" | "FAILED" | "REFUNDED" | "AUTHORIZED" | "PARTIALLY_PAID" | "PAID" | "CAPTURED" | "VOIDED" | "PARTIALLY_REFUNDED"; phone?: string; presentmentCurrency?: string; riskLevel?: "LOW" | "MEDIUM" | "HIGH"; riskScore?: number; shipping?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; carrier?: string; method: "NONE" | "SHIPPING" | "PICK_UP" | "LOCAL_DELIVERY" | "RETAIL"; shippingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; status?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; trackingNumber?: string; trackingUrl?: string; }; shippingRefundedAmount?: number; status: "PENDING" | "PROCESSING" | "COMPLETED" | "CANCELLED" | "CONFIRMED" | "SHIPPED" | "DELIVERED" | "REFUNDED"; storeId?: string; tags?: string[]; timeline?: object[]; totalOutstanding?: number; totalReceived?: number; totalRefunded?: number; updatedAt: Date; }>

assessOrderRisk()​

assessOrderRisk(...args): Promise<{ order: { customerEmail: string; id: string; orderNumber: string; totalAmount: number; }; risk: { assessedAt: Date; causeCancel: boolean; checkoutId: string; createdAt: Date; customerRisk?: { accountAgeDays?: number; chargebackCount?: number; isNewCustomer?: boolean; orderCount?: number; }; deviceRisk?: { browserFingerprint?: string; deviceId?: string; deviceType?: string; userAgent?: string; }; display: boolean; emailRisk?: { disposableEmail?: boolean; emailDomainAgeDays?: number; }; id: string; indicators?: object[]; ipRisk?: { city?: string; country?: string; ipAddress?: string; isProxy?: boolean; isTorExitNode?: boolean; isVpn?: boolean; riskScore?: number; }; level: "LOW" | "MEDIUM" | "HIGH"; merchantNote: string; message: string; orderId: string; orderRisk?: { differentShipBillAddress?: boolean; expeditedShipping?: boolean; failedPaymentAttempts?: number; highValueOrder?: boolean; multipleQuantitySameItem?: boolean; unusualTimeOfDay?: boolean; }; paymentRisk?: { avsResultCode?: string; billingCountryMatchesCard?: boolean; cardBin?: string; cardCountry?: string; cardIssuer?: string; cvvResultCode?: string; shippingCountryMatchesCard?: boolean; }; recommendation: "CANCEL" | "ACCEPT" | "INVESTIGATE"; score: number; source: string; storeId: string; updatedAt: Date; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:786

Parameters​

args​

...[string, string, object]

Returns​

Promise<{ order: { customerEmail: string; id: string; orderNumber: string; totalAmount: number; }; risk: { assessedAt: Date; causeCancel: boolean; checkoutId: string; createdAt: Date; customerRisk?: { accountAgeDays?: number; chargebackCount?: number; isNewCustomer?: boolean; orderCount?: number; }; deviceRisk?: { browserFingerprint?: string; deviceId?: string; deviceType?: string; userAgent?: string; }; display: boolean; emailRisk?: { disposableEmail?: boolean; emailDomainAgeDays?: number; }; id: string; indicators?: object[]; ipRisk?: { city?: string; country?: string; ipAddress?: string; isProxy?: boolean; isTorExitNode?: boolean; isVpn?: boolean; riskScore?: number; }; level: "LOW" | "MEDIUM" | "HIGH"; merchantNote: string; message: string; orderId: string; orderRisk?: { differentShipBillAddress?: boolean; expeditedShipping?: boolean; failedPaymentAttempts?: number; highValueOrder?: boolean; multipleQuantitySameItem?: boolean; unusualTimeOfDay?: boolean; }; paymentRisk?: { avsResultCode?: string; billingCountryMatchesCard?: boolean; cardBin?: string; cardCountry?: string; cardIssuer?: string; cvvResultCode?: string; shippingCountryMatchesCard?: boolean; }; recommendation: "CANCEL" | "ACCEPT" | "INVESTIGATE"; score: number; source: string; storeId: string; updatedAt: Date; }; }>

beginOrderEdit()​

beginOrderEdit(...args): Promise<OrderEditWithDetails>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:641

Parameters​

args​

...[string, string, BeginOrderEditInput]

Returns​

Promise<OrderEditWithDetails>

buildQuery()​

protected buildQuery(options?): Record<string, any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:26

Build query parameters

Parameters​

options?​

ListOptions

Returns​

Record<string, any>

Inherited from​

BaseService.buildQuery

bulkAddTags()​

bulkAddTags(...args): Promise<{ skippedCount: number; success: true; updatedCount: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:130

Parameters​

args​

...[string[], string[], string]

Returns​

Promise<{ skippedCount: number; success: true; updatedCount: number; }>

bulkArchive()​

bulkArchive(...args): Promise<{ archivedCount: number; skippedCount: number; success: true; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:118

Parameters​

args​

...[string[], string]

Returns​

Promise<{ archivedCount: number; skippedCount: number; success: true; }>

bulkCancel()​

bulkCancel(...args): Promise<{ cancelledCount: number; skippedCount: number; success: true; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:178

Parameters​

args​

...[string[], object, string]

Returns​

Promise<{ cancelledCount: number; skippedCount: number; success: true; }>

bulkChangeLocation()​

bulkChangeLocation(...args): Promise<{ changedCount: number; skippedCount: number; success: true; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:166

Parameters​

args​

...[string[], object[], string]

Returns​

Promise<{ changedCount: number; skippedCount: number; success: true; }>

bulkFulfill()​

bulkFulfill(...args): Promise<{ fulfilledCount: number; skippedCount: number; success: true; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:142

Parameters​

args​

...[string[], string, object]

Returns​

Promise<{ fulfilledCount: number; skippedCount: number; success: true; }>

bulkMarkAsPaid()​

bulkMarkAsPaid(...args): Promise<{ currency: string; markedCount: number; skippedCount: number; success: true; totalAmountMarked: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:172

Parameters​

args​

...[string[], string]

Returns​

Promise<{ currency: string; markedCount: number; skippedCount: number; success: true; totalAmountMarked: number; }>

bulkMarkInProgress()​

bulkMarkInProgress(...args): Promise<{ markedCount: number; skippedCount: number; success: true; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:154

Parameters​

args​

...[string[], string]

Returns​

Promise<{ markedCount: number; skippedCount: number; success: true; }>

bulkMarkOnHold()​

bulkMarkOnHold(...args): Promise<{ markedCount: number; skippedCount: number; success: true; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:160

Parameters​

args​

...[string[], string, string, string]

Returns​

Promise<{ markedCount: number; skippedCount: number; success: true; }>

bulkRemoveTags()​

bulkRemoveTags(...args): Promise<{ skippedCount: number; success: true; updatedCount: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:136

Parameters​

args​

...[string[], string[], string]

Returns​

Promise<{ skippedCount: number; success: true; updatedCount: number; }>

bulkUnarchive()​

bulkUnarchive(...args): Promise<{ skippedCount: number; success: true; unarchivedCount: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:124

Parameters​

args​

...[string[], string]

Returns​

Promise<{ skippedCount: number; success: true; unarchivedCount: number; }>

bulkUnfulfill()​

bulkUnfulfill(...args): Promise<{ skippedCount: number; success: true; unfulfilledCount: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:148

Parameters​

args​

...[string[], string]

Returns​

Promise<{ skippedCount: number; success: true; unfulfilledCount: number; }>

calculate()​

calculate(...args): Promise<CalculateOrderResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:208

Parameters​

args​

...[string, CalculateOrderRequest]

Returns​

Promise<CalculateOrderResponse>

calculateOrderEditPreview()​

calculateOrderEditPreview(...args): Promise<CalculateOrderEditPreviewResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:713

Parameters​

args​

...[string, string, CalculateOrderEditPreviewInput]

Returns​

Promise<CalculateOrderEditPreviewResponse>

calculateRefund()​

calculateRefund(...args): Promise<CalculateRefundResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:313

Parameters​

args​

...[string, string, CalculateRefundRequest]

Returns​

Promise<CalculateRefundResponse>

calculateReturnPreview()​

calculateReturnPreview(...args): Promise<{ alreadyRefunded: number; balanceAction: "REFUND" | "COLLECT" | "EVEN"; balanceDue: number; currency: string; discountAmount: number; exchangeLineItems: object[]; exchangeSubtotal: number; exchangeTax: number; exchangeTotal: number; lineItems: object[]; maximumRefundable: number; maxShippingRefundable: number; netReturnValue: number; restockingFee: number; returnShippingFee: number; returnSubtotal: number; returnTax: number; returnTotal: number; shippingRefundAmount: number; taxesIncluded: boolean; taxLines?: object[]; totalFees: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:610

Parameters​

args​

...[string, string, object]

Returns​

Promise<{ alreadyRefunded: number; balanceAction: "REFUND" | "COLLECT" | "EVEN"; balanceDue: number; currency: string; discountAmount: number; exchangeLineItems: object[]; exchangeSubtotal: number; exchangeTax: number; exchangeTotal: number; lineItems: object[]; maximumRefundable: number; maxShippingRefundable: number; netReturnValue: number; restockingFee: number; returnShippingFee: number; returnSubtotal: number; returnTax: number; returnTotal: number; shippingRefundAmount: number; taxesIncluded: boolean; taxLines?: object[]; totalFees: number; }>

cancel()​

cancel(...args): Promise<{ appliedDiscount?: { amount?: number; description?: string; title?: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes?: object[]; archivedAt?: Date; authorizedAmount?: number; autoApplyDiscounts?: boolean; billingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; cancelledAt?: Date; cancelledBy?: string; cancelledByName?: string; cancelNote?: string; cancelReason?: string; capturedAmount?: number; cartDiscountAmount: number; channel?: string; closedAt?: Date; completedAt?: Date; createdAt: Date; currency: string; currentCartDiscountAmount: number; currentSubtotal?: number; currentSubtotalLineItemsQuantity?: number; currentTotalDiscounts: number; currentTotalPrice?: number; currentTotalTax?: number; customer?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; deliveryStatus?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; discountApplications?: object[]; discountCodes: string[]; dutiesRefundedAmount?: number; edited?: boolean; editedAt?: Date; email?: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed?: number; fulfilledAt?: Date; fulfillmentStatus: "SCHEDULED" | "UNFULFILLED" | "PARTIALLY_FULFILLED" | "FULFILLED" | "ON_HOLD"; giftCardAmountApplied?: number; giftCardCode?: string; giftCardsGenerated?: object[]; id: string; items: object[]; marketId?: string; netPayment?: number; notes?: string; orderNumber: string | number; paidAt?: Date; payment?: { amountPaid: number; amountRefunded: number; codeDiscount?: number; currency: string; discount: number; lineItemDiscount?: number; shipping: number; shippingBeforeDiscount?: number; shippingDiscount?: number; subtotal: number; tax: number; taxRate: number; total: number; totalPriceInStoreCurrency?: number; }; paymentMethod?: string; paymentStatus: "PENDING" | "EXPIRED" | "FAILED" | "REFUNDED" | "AUTHORIZED" | "PARTIALLY_PAID" | "PAID" | "CAPTURED" | "VOIDED" | "PARTIALLY_REFUNDED"; phone?: string; presentmentCurrency?: string; riskLevel?: "LOW" | "MEDIUM" | "HIGH"; riskScore?: number; shipping?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; carrier?: string; method: "NONE" | "SHIPPING" | "PICK_UP" | "LOCAL_DELIVERY" | "RETAIL"; shippingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; status?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; trackingNumber?: string; trackingUrl?: string; }; shippingRefundedAmount?: number; status: "PENDING" | "PROCESSING" | "COMPLETED" | "CANCELLED" | "CONFIRMED" | "SHIPPED" | "DELIVERED" | "REFUNDED"; storeId?: string; tags?: string[]; timeline?: object[]; totalOutstanding?: number; totalReceived?: number; totalRefunded?: number; updatedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:76

Parameters​

args​

...[string, object, string]

Returns​

Promise<{ appliedDiscount?: { amount?: number; description?: string; title?: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes?: object[]; archivedAt?: Date; authorizedAmount?: number; autoApplyDiscounts?: boolean; billingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; cancelledAt?: Date; cancelledBy?: string; cancelledByName?: string; cancelNote?: string; cancelReason?: string; capturedAmount?: number; cartDiscountAmount: number; channel?: string; closedAt?: Date; completedAt?: Date; createdAt: Date; currency: string; currentCartDiscountAmount: number; currentSubtotal?: number; currentSubtotalLineItemsQuantity?: number; currentTotalDiscounts: number; currentTotalPrice?: number; currentTotalTax?: number; customer?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; deliveryStatus?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; discountApplications?: object[]; discountCodes: string[]; dutiesRefundedAmount?: number; edited?: boolean; editedAt?: Date; email?: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed?: number; fulfilledAt?: Date; fulfillmentStatus: "SCHEDULED" | "UNFULFILLED" | "PARTIALLY_FULFILLED" | "FULFILLED" | "ON_HOLD"; giftCardAmountApplied?: number; giftCardCode?: string; giftCardsGenerated?: object[]; id: string; items: object[]; marketId?: string; netPayment?: number; notes?: string; orderNumber: string | number; paidAt?: Date; payment?: { amountPaid: number; amountRefunded: number; codeDiscount?: number; currency: string; discount: number; lineItemDiscount?: number; shipping: number; shippingBeforeDiscount?: number; shippingDiscount?: number; subtotal: number; tax: number; taxRate: number; total: number; totalPriceInStoreCurrency?: number; }; paymentMethod?: string; paymentStatus: "PENDING" | "EXPIRED" | "FAILED" | "REFUNDED" | "AUTHORIZED" | "PARTIALLY_PAID" | "PAID" | "CAPTURED" | "VOIDED" | "PARTIALLY_REFUNDED"; phone?: string; presentmentCurrency?: string; riskLevel?: "LOW" | "MEDIUM" | "HIGH"; riskScore?: number; shipping?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; carrier?: string; method: "NONE" | "SHIPPING" | "PICK_UP" | "LOCAL_DELIVERY" | "RETAIL"; shippingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; status?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; trackingNumber?: string; trackingUrl?: string; }; shippingRefundedAmount?: number; status: "PENDING" | "PROCESSING" | "COMPLETED" | "CANCELLED" | "CONFIRMED" | "SHIPPED" | "DELIVERED" | "REFUNDED"; storeId?: string; tags?: string[]; timeline?: object[]; totalOutstanding?: number; totalReceived?: number; totalRefunded?: number; updatedAt: Date; }>

cancelFulfillment()​

cancelFulfillment(...args): Promise<{ createdAt: Date; id: string; items: object[]; status: "partial" | "fulfilled" | "unfulfilled"; trackingInfo?: { company?: string; number: string; url?: string; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:477

Parameters​

args​

...[string, string, string, CancelFulfillmentInput]

Returns​

Promise<{ createdAt: Date; id: string; items: object[]; status: "partial" | "fulfilled" | "unfulfilled"; trackingInfo?: { company?: string; number: string; url?: string; }; }>

cancelFulfillmentOrder()​

cancelFulfillmentOrder(...args): Promise<FulfillmentOrder>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:398

Parameters​

args​

...[string, string, string]

Returns​

Promise<FulfillmentOrder>

cancelReturn()​

cancelReturn(...args): Promise<ReturnWithDetails>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:556

Parameters​

args​

...[string, string, CancelReturnInput]

Returns​

Promise<ReturnWithDetails>

capturePayment()​

capturePayment(...args): Promise<CapturePaymentResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:288

Parameters​

args​

...[string, string, string, CapturePaymentInput]

Returns​

Promise<CapturePaymentResponse>

closeReturn()​

closeReturn(...args): Promise<ReturnWithDetails>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:580

Parameters​

args​

...[string, string]

Returns​

Promise<ReturnWithDetails>

commitOrderEdit()​

commitOrderEdit(...args): Promise<CommitOrderEditResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:707

Parameters​

args​

...[string, string, CommitOrderEditInput]

Returns​

Promise<CommitOrderEditResponse>

create()​

create(...args): Promise<CreateOrderResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:64

Parameters​

args​

...[CreateOrderRequest, string]

Returns​

Promise<CreateOrderResponse>

createAuthorization()​

createAuthorization(...args): Promise<OrderTransaction>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:276

Parameters​

args​

...[string, string, CreateAuthorizationInput]

Returns​

Promise<OrderTransaction>

createDraftOrder()​

createDraftOrder(...args): Promise<{ appliedDiscount: { amount?: number; description?: string; title: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes: object[]; autoApplyDiscounts: boolean; billingAddress: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; billingMatchesShipping: boolean; completedAt: Date; createdAt: Date; createdBy?: string; createdByName?: string; currency: string; customer: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; customerId: string; draftNumber: number; email: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed: number; id: string; invoiceEmailSubject: string; invoiceSentAt: Date; invoiceUrl: string; lineItems: object[]; market: { currency: string; id: string; name: string; }; marketId: string; metafields?: object[]; name: string; note: string; noteAttributes: object[]; order: { id: string; orderNumber: string; status: string; }; orderId: string; paymentTerms: { dueInDays: number; issueDate?: string; paymentDueDate?: string; type: string; }; phone: string; poNumber: string; presentmentCurrency: string; priceLocked: boolean; priceLockedAt: Date; reserveInventoryUntil: Date; shippingAddress: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; shippingLine: { custom?: boolean; handle?: string; price: number; title: string; }; sourceName?: string; status: "COMPLETED" | "OPEN" | "INVOICE_SENT"; storeId: string; subtotalPrice: number; tags: string[]; taxesIncluded: boolean; taxExempt: boolean; taxLines: object[]; timeline?: object[]; totalDiscount: number; totalPrice: number; totalPriceInStoreCurrency?: number; totalShipping: number; totalTax: number; updatedAt: Date; visibleToCustomer: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:811

Parameters​

args​

...[object, string]

Returns​

Promise<{ appliedDiscount: { amount?: number; description?: string; title: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes: object[]; autoApplyDiscounts: boolean; billingAddress: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; billingMatchesShipping: boolean; completedAt: Date; createdAt: Date; createdBy?: string; createdByName?: string; currency: string; customer: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; customerId: string; draftNumber: number; email: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed: number; id: string; invoiceEmailSubject: string; invoiceSentAt: Date; invoiceUrl: string; lineItems: object[]; market: { currency: string; id: string; name: string; }; marketId: string; metafields?: object[]; name: string; note: string; noteAttributes: object[]; order: { id: string; orderNumber: string; status: string; }; orderId: string; paymentTerms: { dueInDays: number; issueDate?: string; paymentDueDate?: string; type: string; }; phone: string; poNumber: string; presentmentCurrency: string; priceLocked: boolean; priceLockedAt: Date; reserveInventoryUntil: Date; shippingAddress: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; shippingLine: { custom?: boolean; handle?: string; price: number; title: string; }; sourceName?: string; status: "COMPLETED" | "OPEN" | "INVOICE_SENT"; storeId: string; subtotalPrice: number; tags: string[]; taxesIncluded: boolean; taxExempt: boolean; taxLines: object[]; timeline?: object[]; totalDiscount: number; totalPrice: number; totalPriceInStoreCurrency?: number; totalShipping: number; totalTax: number; updatedAt: Date; visibleToCustomer: boolean; }>

createFulfillment()​

createFulfillment(...args): Promise<CreateFulfillmentResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:428

Parameters​

args​

...[string, string, string, CreateFulfillmentInput]

Returns​

Promise<CreateFulfillmentResponse>

createOrderRisk()​

createOrderRisk(...args): Promise<{ order: { customerEmail: string; id: string; orderNumber: string; totalAmount: number; }; risk: { assessedAt: Date; causeCancel: boolean; checkoutId: string; createdAt: Date; customerRisk?: { accountAgeDays?: number; chargebackCount?: number; isNewCustomer?: boolean; orderCount?: number; }; deviceRisk?: { browserFingerprint?: string; deviceId?: string; deviceType?: string; userAgent?: string; }; display: boolean; emailRisk?: { disposableEmail?: boolean; emailDomainAgeDays?: number; }; id: string; indicators?: object[]; ipRisk?: { city?: string; country?: string; ipAddress?: string; isProxy?: boolean; isTorExitNode?: boolean; isVpn?: boolean; riskScore?: number; }; level: "LOW" | "MEDIUM" | "HIGH"; merchantNote: string; message: string; orderId: string; orderRisk?: { differentShipBillAddress?: boolean; expeditedShipping?: boolean; failedPaymentAttempts?: number; highValueOrder?: boolean; multipleQuantitySameItem?: boolean; unusualTimeOfDay?: boolean; }; paymentRisk?: { avsResultCode?: string; billingCountryMatchesCard?: boolean; cardBin?: string; cardCountry?: string; cardIssuer?: string; cvvResultCode?: string; shippingCountryMatchesCard?: boolean; }; recommendation: "CANCEL" | "ACCEPT" | "INVESTIGATE"; score: number; source: string; storeId: string; updatedAt: Date; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:780

Parameters​

args​

...[string, string, object]

Returns​

Promise<{ order: { customerEmail: string; id: string; orderNumber: string; totalAmount: number; }; risk: { assessedAt: Date; causeCancel: boolean; checkoutId: string; createdAt: Date; customerRisk?: { accountAgeDays?: number; chargebackCount?: number; isNewCustomer?: boolean; orderCount?: number; }; deviceRisk?: { browserFingerprint?: string; deviceId?: string; deviceType?: string; userAgent?: string; }; display: boolean; emailRisk?: { disposableEmail?: boolean; emailDomainAgeDays?: number; }; id: string; indicators?: object[]; ipRisk?: { city?: string; country?: string; ipAddress?: string; isProxy?: boolean; isTorExitNode?: boolean; isVpn?: boolean; riskScore?: number; }; level: "LOW" | "MEDIUM" | "HIGH"; merchantNote: string; message: string; orderId: string; orderRisk?: { differentShipBillAddress?: boolean; expeditedShipping?: boolean; failedPaymentAttempts?: number; highValueOrder?: boolean; multipleQuantitySameItem?: boolean; unusualTimeOfDay?: boolean; }; paymentRisk?: { avsResultCode?: string; billingCountryMatchesCard?: boolean; cardBin?: string; cardCountry?: string; cardIssuer?: string; cvvResultCode?: string; shippingCountryMatchesCard?: boolean; }; recommendation: "CANCEL" | "ACCEPT" | "INVESTIGATE"; score: number; source: string; storeId: string; updatedAt: Date; }; }>

createRefund()​

createRefund(...args): Promise<{ order: { id: string; orderNumber: string; paymentStatus: string; totalRefunded: number; }; refund: { baseCurrency?: string; createdAt: Date; createdBy?: string; createdByName?: string; currency: string; dutiesAmount: number; exchangeRateUsed?: number; id: string; lineItems?: object[]; notifiedAt?: Date; notifyCustomer: boolean; orderId: string; processedAt?: Date; reason?: string; reasonNote?: string; refundMethod: "MANUAL" | "ORIGINAL_PAYMENT" | "STORE_CREDIT"; refundNumber: string; shippingAmount: number; status: "PENDING" | "CANCELLED" | "SUCCESS" | "FAILURE"; storeId: string; subtotalAmount: number; taxAmount: number; totalAmount: number; transactions?: object[]; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:319

Parameters​

args​

...[string, string, object]

Returns​

Promise<{ order: { id: string; orderNumber: string; paymentStatus: string; totalRefunded: number; }; refund: { baseCurrency?: string; createdAt: Date; createdBy?: string; createdByName?: string; currency: string; dutiesAmount: number; exchangeRateUsed?: number; id: string; lineItems?: object[]; notifiedAt?: Date; notifyCustomer: boolean; orderId: string; processedAt?: Date; reason?: string; reasonNote?: string; refundMethod: "MANUAL" | "ORIGINAL_PAYMENT" | "STORE_CREDIT"; refundNumber: string; shippingAmount: number; status: "PENDING" | "CANCELLED" | "SUCCESS" | "FAILURE"; storeId: string; subtotalAmount: number; taxAmount: number; totalAmount: number; transactions?: object[]; }; }>

createRefundTransaction()​

createRefundTransaction(...args): Promise<OrderTransaction>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:300

Parameters​

args​

...[string, string, CreateRefundTransactionInput]

Returns​

Promise<OrderTransaction>

createSale()​

createSale(...args): Promise<OrderTransaction>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:282

Parameters​

args​

...[string, string, CreateSaleInput]

Returns​

Promise<OrderTransaction>

declineReturn()​

declineReturn(...args): Promise<ReturnWithDetails>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:550

Parameters​

args​

...[string, string, DeclineReturnInput]

Returns​

Promise<ReturnWithDetails>

delete()​

delete(...args): Promise<{ deleted: true; id: string; object: "order"; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:202

Parameters​

args​

...[string, string]

Returns​

Promise<{ deleted: true; id: string; object: "order"; }>

deleteDraftOrder()​

deleteDraftOrder(...args): Promise<{ deleted: true; id: string; object: "draft_order"; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:841

Parameters​

args​

...[string, string]

Returns​

Promise<{ deleted: true; id: string; object: "draft_order"; }>

deleteDraftOrderTimelineComment()​

deleteDraftOrderTimelineComment(...args): Promise<void>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:865

Parameters​

args​

...[string, string, string]

Returns​

Promise<void>

deleteOrderRisk()​

deleteOrderRisk(...args): Promise<{ deleted: true; id: string; object: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:762

Parameters​

args​

...[string, string]

Returns​

Promise<{ deleted: true; id: string; object: string; }>

deleteTimelineComment()​

deleteTimelineComment(...args): Promise<{ success: true; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:233

Parameters​

args​

...[string, string, string]

Returns​

Promise<{ success: true; }>

duplicate()​

duplicate(...args): Promise<{ draftOrder: DraftOrder; sourceOrder: { id: string; orderNumber: string; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:184

Parameters​

args​

...[string, DuplicateOrderRequest, string]

Returns​

Promise<{ draftOrder: DraftOrder; sourceOrder: { id: string; orderNumber: string; }; }>

editDraftOrderTimelineComment()​

editDraftOrderTimelineComment(...args): Promise<DraftOrderTimeline>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:859

Parameters​

args​

...[string, string, string, string]

Returns​

Promise<DraftOrderTimeline>

editTimelineComment()​

editTimelineComment(...args): Promise<{ attachments?: object[]; authorId?: string; authorName?: string; createdAt: Date; description?: string; editedAt?: Date; id: string; isComment: boolean; isEdited: boolean; isSystem: boolean; mentions?: object[]; metadata?: Record<string, unknown>; timestamp: Date; title: string; type: "NOTIFICATION_SENT" | "NOTIFICATION_FAILED" | "NOTIFICATION_RESENT" | "TRACKING_ADDED" | "TRACKING_UPDATED" | "NOTE_ADDED" | "COMMENT" | "SHIPMENT_CREATED" | "ORDER_CANCELLED" | "ORDER_EDITED" | "REFUND_ISSUED" | "DELIVERED" | "ORDER_CREATED" | "ORDER_CONFIRMED" | "CONFIRMATION_GENERATED" | "ORDER_CLOSED" | "ORDER_REOPENED" | "ORDER_ARCHIVED" | "ORDER_UNARCHIVED" | "PAYMENT_CAPTURED" | "PAYMENT_FAILED" | "PAYMENT_PENDING" | "AUTHORIZATION_SUCCESS" | "AUTHORIZATION_PENDING" | "AUTHORIZATION_FAILURE" | "AUTHORIZATION_EXPIRED" | "VOID_SUCCESS" | "VOID_PENDING" | "VOID_FAILURE" | "SALE_SUCCESS" | "SALE_PENDING" | "SALE_FAILURE" | "FULFILLMENT_CREATED" | "FULFILLMENT_IN_PROGRESS" | "FULFILLMENT_UNFULFILLED" | "FULFILLMENT_HOLD" | "FULFILLMENT_RELEASED" | "FULFILLMENT_RELEASED_STATUS" | "FULFILLMENT_RESCHEDULED" | "FULFILLMENT_MOVED" | "FULFILLMENT_SPLIT" | "FULFILLMENT_MERGED" | "GIFT_CARD_FULFILLED" | "FULFILLMENT_CANCELLED" | "FULFILLMENT_PENDING" | "RESTOCK_LINE_ITEMS" | "REFUND_CREATED" | "REFUND_PROCESSED" | "REFUND_PENDING" | "REFUND_FAILED" | "RETURN_CREATED" | "RETURN_TRACKING_ADDED" | "RETURN_TRACKING_UPDATED" | "RETURN_LABEL_UPLOADED" | "RETURN_LABEL_REMOVED" | "RETURN_DECLINED" | "RETURN_CANCELLED" | "RETURN_ITEMS_RECEIVED" | "RETURN_PROCESSED" | "RETURN_CLOSED" | "RETURN_REOPENED" | "TRACKING_REMOVED" | "RISK_ASSESSED"; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:227

Parameters​

args​

...[string, string, EditTimelineCommentRequest, string]

Returns​

Promise<{ attachments?: object[]; authorId?: string; authorName?: string; createdAt: Date; description?: string; editedAt?: Date; id: string; isComment: boolean; isEdited: boolean; isSystem: boolean; mentions?: object[]; metadata?: Record<string, unknown>; timestamp: Date; title: string; type: "NOTIFICATION_SENT" | "NOTIFICATION_FAILED" | "NOTIFICATION_RESENT" | "TRACKING_ADDED" | "TRACKING_UPDATED" | "NOTE_ADDED" | "COMMENT" | "SHIPMENT_CREATED" | "ORDER_CANCELLED" | "ORDER_EDITED" | "REFUND_ISSUED" | "DELIVERED" | "ORDER_CREATED" | "ORDER_CONFIRMED" | "CONFIRMATION_GENERATED" | "ORDER_CLOSED" | "ORDER_REOPENED" | "ORDER_ARCHIVED" | "ORDER_UNARCHIVED" | "PAYMENT_CAPTURED" | "PAYMENT_FAILED" | "PAYMENT_PENDING" | "AUTHORIZATION_SUCCESS" | "AUTHORIZATION_PENDING" | "AUTHORIZATION_FAILURE" | "AUTHORIZATION_EXPIRED" | "VOID_SUCCESS" | "VOID_PENDING" | "VOID_FAILURE" | "SALE_SUCCESS" | "SALE_PENDING" | "SALE_FAILURE" | "FULFILLMENT_CREATED" | "FULFILLMENT_IN_PROGRESS" | "FULFILLMENT_UNFULFILLED" | "FULFILLMENT_HOLD" | "FULFILLMENT_RELEASED" | "FULFILLMENT_RELEASED_STATUS" | "FULFILLMENT_RESCHEDULED" | "FULFILLMENT_MOVED" | "FULFILLMENT_SPLIT" | "FULFILLMENT_MERGED" | "GIFT_CARD_FULFILLED" | "FULFILLMENT_CANCELLED" | "FULFILLMENT_PENDING" | "RESTOCK_LINE_ITEMS" | "REFUND_CREATED" | "REFUND_PROCESSED" | "REFUND_PENDING" | "REFUND_FAILED" | "RETURN_CREATED" | "RETURN_TRACKING_ADDED" | "RETURN_TRACKING_UPDATED" | "RETURN_LABEL_UPLOADED" | "RETURN_LABEL_REMOVED" | "RETURN_DECLINED" | "RETURN_CANCELLED" | "RETURN_ITEMS_RECEIVED" | "RETURN_PROCESSED" | "RETURN_CLOSED" | "RETURN_REOPENED" | "TRACKING_REMOVED" | "RISK_ASSESSED"; }>

editTracking()​

editTracking(...args): Promise<{ carrierId?: string; carrierInfo?: { alias?: string; country?: string; homepage?: string; key: number; name: string; }; createdAt: Date; daysInTransit?: number; deliveredAt?: Date; estimatedDeliveryAt?: Date; events?: object[]; fulfillmentId: string; id: string; lastTrackingSync?: Date; milestones?: object[]; registeredAt?: Date; registrationError?: string; registrationStatus: "PENDING" | "EXPIRED" | "FAILED" | "ACTIVE" | "REGISTERED"; shipmentStatus: "PENDING" | "EXPIRED" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "INFO_RECEIVED" | "FAILED_ATTEMPT" | "EXCEPTION" | "RETURNED_TO_SENDER"; shippedAt?: Date; shippingInfo?: { recipientAddress?: { city?: string; coordinates?: { latitude?: number; longitude?: number; }; country?: string; postalCode?: string; state?: string; street?: string; }; shipperAddress?: { city?: string; coordinates?: { latitude?: number; longitude?: number; }; country?: string; postalCode?: string; state?: string; street?: string; }; }; storeId: string; syncCount: number; timeMetrics?: { daysAfterLastUpdate?: number; daysAfterOrder?: number; daysOfTransit?: number; daysOfTransitDone?: number; estimatedDeliveryDate?: { from?: Date; source?: string; to?: Date; }; }; trackingCompany?: string; trackingNumber: string; trackingSource?: string; trackingUrl?: string; updatedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:465

Parameters​

args​

...[string, string, string, string, Partial<{ carrierId?: string; notifyCustomer: boolean; trackingCompany?: string; trackingNumber: string; trackingUrl?: string; }>]

Returns​

Promise<{ carrierId?: string; carrierInfo?: { alias?: string; country?: string; homepage?: string; key: number; name: string; }; createdAt: Date; daysInTransit?: number; deliveredAt?: Date; estimatedDeliveryAt?: Date; events?: object[]; fulfillmentId: string; id: string; lastTrackingSync?: Date; milestones?: object[]; registeredAt?: Date; registrationError?: string; registrationStatus: "PENDING" | "EXPIRED" | "FAILED" | "ACTIVE" | "REGISTERED"; shipmentStatus: "PENDING" | "EXPIRED" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "INFO_RECEIVED" | "FAILED_ATTEMPT" | "EXCEPTION" | "RETURNED_TO_SENDER"; shippedAt?: Date; shippingInfo?: { recipientAddress?: { city?: string; coordinates?: { latitude?: number; longitude?: number; }; country?: string; postalCode?: string; state?: string; street?: string; }; shipperAddress?: { city?: string; coordinates?: { latitude?: number; longitude?: number; }; country?: string; postalCode?: string; state?: string; street?: string; }; }; storeId: string; syncCount: number; timeMetrics?: { daysAfterLastUpdate?: number; daysAfterOrder?: number; daysOfTransit?: number; daysOfTransitDone?: number; estimatedDeliveryDate?: { from?: Date; source?: string; to?: Date; }; }; trackingCompany?: string; trackingNumber: string; trackingSource?: string; trackingUrl?: string; updatedAt: Date; }>

fulfill()​

fulfill(...args): Promise<{ appliedDiscount?: { amount?: number; description?: string; title?: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes?: object[]; archivedAt?: Date; authorizedAmount?: number; autoApplyDiscounts?: boolean; billingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; cancelledAt?: Date; cancelledBy?: string; cancelledByName?: string; cancelNote?: string; cancelReason?: string; capturedAmount?: number; cartDiscountAmount: number; channel?: string; closedAt?: Date; completedAt?: Date; createdAt: Date; currency: string; currentCartDiscountAmount: number; currentSubtotal?: number; currentSubtotalLineItemsQuantity?: number; currentTotalDiscounts: number; currentTotalPrice?: number; currentTotalTax?: number; customer?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; deliveryStatus?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; discountApplications?: object[]; discountCodes: string[]; dutiesRefundedAmount?: number; edited?: boolean; editedAt?: Date; email?: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed?: number; fulfilledAt?: Date; fulfillmentStatus: "SCHEDULED" | "UNFULFILLED" | "PARTIALLY_FULFILLED" | "FULFILLED" | "ON_HOLD"; giftCardAmountApplied?: number; giftCardCode?: string; giftCardsGenerated?: object[]; id: string; items: object[]; marketId?: string; netPayment?: number; notes?: string; orderNumber: string | number; paidAt?: Date; payment?: { amountPaid: number; amountRefunded: number; codeDiscount?: number; currency: string; discount: number; lineItemDiscount?: number; shipping: number; shippingBeforeDiscount?: number; shippingDiscount?: number; subtotal: number; tax: number; taxRate: number; total: number; totalPriceInStoreCurrency?: number; }; paymentMethod?: string; paymentStatus: "PENDING" | "EXPIRED" | "FAILED" | "REFUNDED" | "AUTHORIZED" | "PARTIALLY_PAID" | "PAID" | "CAPTURED" | "VOIDED" | "PARTIALLY_REFUNDED"; phone?: string; presentmentCurrency?: string; riskLevel?: "LOW" | "MEDIUM" | "HIGH"; riskScore?: number; shipping?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; carrier?: string; method: "NONE" | "SHIPPING" | "PICK_UP" | "LOCAL_DELIVERY" | "RETAIL"; shippingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; status?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; trackingNumber?: string; trackingUrl?: string; }; shippingRefundedAmount?: number; status: "PENDING" | "PROCESSING" | "COMPLETED" | "CANCELLED" | "CONFIRMED" | "SHIPPED" | "DELIVERED" | "REFUNDED"; storeId?: string; tags?: string[]; timeline?: object[]; totalOutstanding?: number; totalReceived?: number; totalRefunded?: number; updatedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:88

Parameters​

args​

...[string, object, string]

Returns​

Promise<{ appliedDiscount?: { amount?: number; description?: string; title?: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes?: object[]; archivedAt?: Date; authorizedAmount?: number; autoApplyDiscounts?: boolean; billingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; cancelledAt?: Date; cancelledBy?: string; cancelledByName?: string; cancelNote?: string; cancelReason?: string; capturedAmount?: number; cartDiscountAmount: number; channel?: string; closedAt?: Date; completedAt?: Date; createdAt: Date; currency: string; currentCartDiscountAmount: number; currentSubtotal?: number; currentSubtotalLineItemsQuantity?: number; currentTotalDiscounts: number; currentTotalPrice?: number; currentTotalTax?: number; customer?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; deliveryStatus?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; discountApplications?: object[]; discountCodes: string[]; dutiesRefundedAmount?: number; edited?: boolean; editedAt?: Date; email?: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed?: number; fulfilledAt?: Date; fulfillmentStatus: "SCHEDULED" | "UNFULFILLED" | "PARTIALLY_FULFILLED" | "FULFILLED" | "ON_HOLD"; giftCardAmountApplied?: number; giftCardCode?: string; giftCardsGenerated?: object[]; id: string; items: object[]; marketId?: string; netPayment?: number; notes?: string; orderNumber: string | number; paidAt?: Date; payment?: { amountPaid: number; amountRefunded: number; codeDiscount?: number; currency: string; discount: number; lineItemDiscount?: number; shipping: number; shippingBeforeDiscount?: number; shippingDiscount?: number; subtotal: number; tax: number; taxRate: number; total: number; totalPriceInStoreCurrency?: number; }; paymentMethod?: string; paymentStatus: "PENDING" | "EXPIRED" | "FAILED" | "REFUNDED" | "AUTHORIZED" | "PARTIALLY_PAID" | "PAID" | "CAPTURED" | "VOIDED" | "PARTIALLY_REFUNDED"; phone?: string; presentmentCurrency?: string; riskLevel?: "LOW" | "MEDIUM" | "HIGH"; riskScore?: number; shipping?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; carrier?: string; method: "NONE" | "SHIPPING" | "PICK_UP" | "LOCAL_DELIVERY" | "RETAIL"; shippingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; status?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; trackingNumber?: string; trackingUrl?: string; }; shippingRefundedAmount?: number; status: "PENDING" | "PROCESSING" | "COMPLETED" | "CANCELLED" | "CONFIRMED" | "SHIPPED" | "DELIVERED" | "REFUNDED"; storeId?: string; tags?: string[]; timeline?: object[]; totalOutstanding?: number; totalReceived?: number; totalRefunded?: number; updatedAt: Date; }>

generateIdempotencyKey()​

protected generateIdempotencyKey(prefix): string

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:19

Generate idempotency key

Parameters​

prefix​

string

Returns​

string

Inherited from​

BaseService.generateIdempotencyKey

getAnalytics()​

getAnalytics(...args): Promise<{ itemsOrdered: number; ordersFulfilled: number; returns: number; totalOrders: number; trend?: object[]; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:196

Parameters​

args​

...[string, object]

Returns​

Promise<{ itemsOrdered: number; ordersFulfilled: number; returns: number; totalOrders: number; trend?: object[]; }>

getAutoApplyDiscounts()​

getAutoApplyDiscounts(...args): Promise<{ discounts: object[]; total: number; totalDiscountAmount: number; totalShippingDiscount: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:883

Parameters​

args​

...[string, object]

Returns​

Promise<{ discounts: object[]; total: number; totalDiscountAmount: number; totalShippingDiscount: number; }>

getCalculatedOrderEdit()​

getCalculatedOrderEdit(...args): Promise<CalculatedOrderSummary>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:665

Parameters​

args​

...[string, string]

Returns​

Promise<CalculatedOrderSummary>

getCounts()​

getCounts(...args): Promise<Record<string, unknown>>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:52

Parameters​

args​

...[string]

Returns​

Promise<Record<string, unknown>>

getDraftOrderConversionMetrics()​

getDraftOrderConversionMetrics(...args): Promise<{ data: { averageTimeToConvert: number; conversionRate: number; conversionsByStaff: object[]; conversionTrend: object[]; convertedDraftOrders: number; convertedValue: number; dateRange: { end: string; start: string; }; statusCounts: { completed: number; invoiceSent: number; open: number; }; totalDraftOrders: number; totalDraftValue: number; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:889

Parameters​

args​

...[string, object]

Returns​

Promise<{ data: { averageTimeToConvert: number; conversionRate: number; conversionsByStaff: object[]; conversionTrend: object[]; convertedDraftOrders: number; convertedValue: number; dateRange: { end: string; start: string; }; statusCounts: { completed: number; invoiceSent: number; open: number; }; totalDraftOrders: number; totalDraftValue: number; }; }>

getDraftOrderCounts()​

getDraftOrderCounts(...args): Promise<{ data: { all: number; completed: number; invoiceSent: number; open: number; }; success: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:799

Parameters​

args​

...[string]

Returns​

Promise<{ data: { all: number; completed: number; invoiceSent: number; open: number; }; success: boolean; }>

getDraftOrderTimeline()​

getDraftOrderTimeline(...args): Promise<DraftOrderTimeline[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:847

Parameters​

args​

...[string, string]

Returns​

Promise<DraftOrderTimeline[]>

getExchangeFinancialSummary()​

getExchangeFinancialSummary(...args): Promise<{ exchangeItems: object[]; isExchange: boolean; returnId: string; returnItems: object[]; returnNumber: string; summary: { balanceAction: "NONE" | "REFUND" | "COLLECT"; balanceDue: number; exchangeTotal: number; returnValue: number; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:622

Parameters​

args​

...[string, string]

Returns​

Promise<{ exchangeItems: object[]; isExchange: boolean; returnId: string; returnItems: object[]; returnNumber: string; summary: { balanceAction: "NONE" | "REFUND" | "COLLECT"; balanceDue: number; exchangeTotal: number; returnValue: number; }; }>

getExportMimeType()​

protected getExportMimeType(format): string

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:45

Get MIME type for export format

Parameters​

format​

string

Returns​

string

Inherited from​

BaseService.getExportMimeType

getFulfillment()​

getFulfillment(...args): Promise<{ createdAt: Date; id: string; items: object[]; status: "partial" | "fulfilled" | "unfulfilled"; trackingInfo?: { company?: string; number: string; url?: string; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:441

Parameters​

args​

...[string, string, string]

Returns​

Promise<{ createdAt: Date; id: string; items: object[]; status: "partial" | "fulfilled" | "unfulfilled"; trackingInfo?: { company?: string; number: string; url?: string; }; }>

getFulfillmentOrder()​

getFulfillmentOrder(...args): Promise<FulfillmentOrder>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:356

Parameters​

args​

...[string, string, string]

Returns​

Promise<FulfillmentOrder>

getFulfillmentOrdersForMerge()​

getFulfillmentOrdersForMerge(...args): Promise<FulfillmentOrder[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:422

Parameters​

args​

...[string, string, string]

Returns​

Promise<FulfillmentOrder[]>

getFulfillmentSummary()​

getFulfillmentSummary(...args): Promise<OrderFulfillmentSummary>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:350

Parameters​

args​

...[string, string]

Returns​

Promise<OrderFulfillmentSummary>

getHighRiskOrders()​

getHighRiskOrders(...args): Promise<HighRiskOrdersResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:738

Parameters​

args​

...[string, object]

Returns​

Promise<HighRiskOrdersResponse>

getMentionableStaff()​

getMentionableStaff(...args): Promise<MentionableStaff[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:239

Parameters​

args​

...[string, string]

Returns​

Promise<MentionableStaff[]>

getOrderEdit()​

getOrderEdit(...args): Promise<OrderEditWithDetails>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:659

Parameters​

args​

...[string, string]

Returns​

Promise<OrderEditWithDetails>

getOrderReturnSummary()​

getOrderReturnSummary(...args): Promise<OrderReturnSummary>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:508

Parameters​

args​

...[string, string]

Returns​

Promise<OrderReturnSummary>

getOrderRisk()​

getOrderRisk(...args): Promise<{ assessedAt: Date; causeCancel: boolean; checkoutId: string; createdAt: Date; customerRisk?: { accountAgeDays?: number; chargebackCount?: number; isNewCustomer?: boolean; orderCount?: number; }; deviceRisk?: { browserFingerprint?: string; deviceId?: string; deviceType?: string; userAgent?: string; }; display: boolean; emailRisk?: { disposableEmail?: boolean; emailDomainAgeDays?: number; }; id: string; indicators?: object[]; ipRisk?: { city?: string; country?: string; ipAddress?: string; isProxy?: boolean; isTorExitNode?: boolean; isVpn?: boolean; riskScore?: number; }; level: "LOW" | "MEDIUM" | "HIGH"; merchantNote: string; message: string; orderId: string; orderRisk?: { differentShipBillAddress?: boolean; expeditedShipping?: boolean; failedPaymentAttempts?: number; highValueOrder?: boolean; multipleQuantitySameItem?: boolean; unusualTimeOfDay?: boolean; }; paymentRisk?: { avsResultCode?: string; billingCountryMatchesCard?: boolean; cardBin?: string; cardCountry?: string; cardIssuer?: string; cvvResultCode?: string; shippingCountryMatchesCard?: boolean; }; recommendation: "CANCEL" | "ACCEPT" | "INVESTIGATE"; score: number; source: string; storeId: string; updatedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:750

Parameters​

args​

...[string, string]

Returns​

Promise<{ assessedAt: Date; causeCancel: boolean; checkoutId: string; createdAt: Date; customerRisk?: { accountAgeDays?: number; chargebackCount?: number; isNewCustomer?: boolean; orderCount?: number; }; deviceRisk?: { browserFingerprint?: string; deviceId?: string; deviceType?: string; userAgent?: string; }; display: boolean; emailRisk?: { disposableEmail?: boolean; emailDomainAgeDays?: number; }; id: string; indicators?: object[]; ipRisk?: { city?: string; country?: string; ipAddress?: string; isProxy?: boolean; isTorExitNode?: boolean; isVpn?: boolean; riskScore?: number; }; level: "LOW" | "MEDIUM" | "HIGH"; merchantNote: string; message: string; orderId: string; orderRisk?: { differentShipBillAddress?: boolean; expeditedShipping?: boolean; failedPaymentAttempts?: number; highValueOrder?: boolean; multipleQuantitySameItem?: boolean; unusualTimeOfDay?: boolean; }; paymentRisk?: { avsResultCode?: string; billingCountryMatchesCard?: boolean; cardBin?: string; cardCountry?: string; cardIssuer?: string; cvvResultCode?: string; shippingCountryMatchesCard?: boolean; }; recommendation: "CANCEL" | "ACCEPT" | "INVESTIGATE"; score: number; source: string; storeId: string; updatedAt: Date; }>

getOrderRiskAggregate()​

getOrderRiskAggregate(...args): Promise<{ displayedRiskCount: number; highestLevel: "LOW" | "MEDIUM" | "HIGH"; highestScore: number; latestAssessedAt: Date; orderId: string; recommendedAction: "CANCEL" | "ACCEPT" | "INVESTIGATE"; risks: object[]; totalRiskCount: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:774

Parameters​

args​

...[string, string]

Returns​

Promise<{ displayedRiskCount: number; highestLevel: "LOW" | "MEDIUM" | "HIGH"; highestScore: number; latestAssessedAt: Date; orderId: string; recommendedAction: "CANCEL" | "ACCEPT" | "INVESTIGATE"; risks: object[]; totalRiskCount: number; }>

getPaymentSummary()​

getPaymentSummary(...args): Promise<OrderPaymentSummary>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:264

Parameters​

args​

...[string, string]

Returns​

Promise<OrderPaymentSummary>

getRefund()​

getRefund(...args): Promise<Refund>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:337

Parameters​

args​

...[string, string, string]

Returns​

Promise<Refund>

getRefundSummary()​

getRefundSummary(...args): Promise<OrderRefundSummary>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:331

Parameters​

args​

...[string, string]

Returns​

Promise<OrderRefundSummary>

getRemovedItems()​

getRemovedItems(...args): Promise<{ data: { removedItems: object[]; totalRemovedItems: number; totalRemovedQuantity: number; }; success: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:725

Parameters​

args​

...[string, string]

Returns​

Promise<{ data: { removedItems: object[]; totalRemovedItems: number; totalRemovedQuantity: number; }; success: boolean; }>

getReturn()​

getReturn(...args): Promise<ReturnWithDetails>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:532

Parameters​

args​

...[string, string]

Returns​

Promise<ReturnWithDetails>

getReturnableItems()​

getReturnableItems(...args): Promise<GetReturnableItemsResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:502

Parameters​

args​

...[string, string]

Returns​

Promise<GetReturnableItemsResponse>

getRiskStatistics()​

getRiskStatistics(...args): Promise<{ averageScore: number; byLevel: Record<RiskLevel, number>; byRecommendation: Record<RiskRecommendation, number>; totalRisks: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:744

Parameters​

args​

...[string, object]

Returns​

Promise<{ averageScore: number; byLevel: Record<RiskLevel, number>; byRecommendation: Record<RiskRecommendation, number>; totalRisks: number; }>

getSuggestedFinancialOutcome()​

getSuggestedFinancialOutcome(...args): Promise<SuggestedFinancialOutcome>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:604

Parameters​

args​

...[string, string]

Returns​

Promise<SuggestedFinancialOutcome>

getSuggestedRefund()​

getSuggestedRefund(...args): Promise<SuggestedRefund>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:538

Parameters​

args​

...[string, string]

Returns​

Promise<SuggestedRefund>

getTagSuggestions()​

getTagSuggestions(...args): Promise<string[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:913

Parameters​

args​

...[string, string]

Returns​

Promise<string[]>

getTagSuggestionsPaginated()​

getTagSuggestionsPaginated(...args): Promise<{ limit: number; page: number; tags: string[]; total: number; totalPages: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:919

Parameters​

args​

...[string, object]

Returns​

Promise<{ limit: number; page: number; tags: string[]; total: number; totalPages: number; }>

getTimeline()​

getTimeline(...args): Promise<object[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:215

Parameters​

args​

...[string, string]

Returns​

Promise<object[]>

getTransaction()​

getTransaction(...args): Promise<OrderTransaction>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:270

Parameters​

args​

...[string, string, string]

Returns​

Promise<OrderTransaction>

holdFulfillmentOrder()​

holdFulfillmentOrder(...args): Promise<FulfillmentOrder>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:362

Parameters​

args​

...[string, string, string, HoldFulfillmentOrderInput]

Returns​

Promise<FulfillmentOrder>

holdPartialFulfillmentOrder()​

holdPartialFulfillmentOrder(...args): Promise<{ held: FulfillmentOrder; original: FulfillmentOrder; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:368

Parameters​

args​

...[string, string, string, any]

Returns​

Promise<{ held: FulfillmentOrder; original: FulfillmentOrder; }>

list()​

list(...args): Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:48

Parameters​

args​

...[string, object]

Returns​

Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

listAbandonedCheckouts()​

listAbandonedCheckouts(...args): Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:895

Parameters​

args​

...[string, object]

Returns​

Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

listDraftOrders()​

listDraftOrders(...args): Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:793

Parameters​

args​

...[string, object]

Returns​

Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

listFulfillmentEvents()​

listFulfillmentEvents(...args): Promise<{ data: FulfillmentEvent[]; fulfillment: { deliveredAt?: Date; estimatedDeliveryAt?: Date; id: string; name: string; shipmentStatus?: string; shippedAt?: Date; trackingCompany?: string; trackingNumber?: string; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:483

Parameters​

args​

...[string, string, string]

Returns​

Promise<{ data: FulfillmentEvent[]; fulfillment: { deliveredAt?: Date; estimatedDeliveryAt?: Date; id: string; name: string; shipmentStatus?: string; shippedAt?: Date; trackingCompany?: string; trackingNumber?: string; }; }>

listFulfillmentOrders()​

listFulfillmentOrders(...args): Promise<ListFulfillmentOrdersResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:344

Parameters​

args​

...[string, string, ListFulfillmentOrdersParams]

Returns​

Promise<ListFulfillmentOrdersResponse>

listFulfillments()​

listFulfillments(...args): Promise<ListFulfillmentsResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:435

Parameters​

args​

...[string, string, ListFulfillmentsParams]

Returns​

Promise<ListFulfillmentsResponse>

listOrderEdits()​

listOrderEdits(...args): Promise<ListOrderEditsResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:647

Parameters​

args​

...[string, string, object]

Returns​

Promise<ListOrderEditsResponse>

listOrderReturns()​

listOrderReturns(...args): Promise<ListReturnsResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:514

Parameters​

args​

...[string, string, ListReturnsQuery]

Returns​

Promise<ListReturnsResponse>

listOrderRisks()​

listOrderRisks(...args): Promise<{ pagination: { limit: number; page: number; total: number; totalPages: number; }; risks: object[]; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:732

Parameters​

args​

...[string, object]

Returns​

Promise<{ pagination: { limit: number; page: number; total: number; totalPages: number; }; risks: object[]; }>

listRefunds()​

listRefunds(...args): Promise<ListRefundsResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:325

Parameters​

args​

...[string, string, ListRefundsParams]

Returns​

Promise<ListRefundsResponse>

listReturns()​

listReturns(...args): Promise<ListReturnsResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:526

Parameters​

args​

...[string, ListReturnsQuery]

Returns​

Promise<ListReturnsResponse>

listRisksForOrder()​

listRisksForOrder(...args): Promise<object[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:768

Parameters​

args​

...[string, string]

Returns​

Promise<object[]>

listStoreOrderEdits()​

listStoreOrderEdits(...args): Promise<ListOrderEditsResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:653

Parameters​

args​

...[string, object]

Returns​

Promise<ListOrderEditsResponse>

listStoreTransactions()​

listStoreTransactions(...args): Promise<ListStoreTransactionsResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:258

Parameters​

args​

...[string, ListStoreTransactionsParams]

Returns​

Promise<ListStoreTransactionsResponse>

listTrackings()​

listTrackings(...args): Promise<object[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:447

Parameters​

args​

...[string, string, string]

Returns​

Promise<object[]>

listTransactions()​

listTransactions(...args): Promise<ListTransactionsResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:252

Parameters​

args​

...[string, string, ListTransactionsParams]

Returns​

Promise<ListTransactionsResponse>

markDraftAsPaid()​

markDraftAsPaid(...args): Promise<{ draftOrder: { appliedDiscount: { amount?: number; description?: string; title: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes: object[]; autoApplyDiscounts: boolean; billingAddress: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; billingMatchesShipping: boolean; completedAt: Date; createdAt: Date; createdBy?: string; createdByName?: string; currency: string; customer: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; customerId: string; draftNumber: number; email: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed: number; id: string; invoiceEmailSubject: string; invoiceSentAt: Date; invoiceUrl: string; lineItems: object[]; market: { currency: string; id: string; name: string; }; marketId: string; metafields?: object[]; name: string; note: string; noteAttributes: object[]; order: { id: string; orderNumber: string; status: string; }; orderId: string; paymentTerms: { dueInDays: number; issueDate?: string; paymentDueDate?: string; type: string; }; phone: string; poNumber: string; presentmentCurrency: string; priceLocked: boolean; priceLockedAt: Date; reserveInventoryUntil: Date; shippingAddress: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; shippingLine: { custom?: boolean; handle?: string; price: number; title: string; }; sourceName?: string; status: "COMPLETED" | "OPEN" | "INVOICE_SENT"; storeId: string; subtotalPrice: number; tags: string[]; taxesIncluded: boolean; taxExempt: boolean; taxLines: object[]; timeline?: object[]; totalDiscount: number; totalPrice: number; totalPriceInStoreCurrency?: number; totalShipping: number; totalTax: number; updatedAt: Date; visibleToCustomer: boolean; }; order: { appliedDiscount?: { amount?: number; description?: string; title?: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes?: object[]; archivedAt?: Date; authorizedAmount?: number; autoApplyDiscounts?: boolean; billingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; cancelledAt?: Date; cancelledBy?: string; cancelledByName?: string; cancelNote?: string; cancelReason?: string; capturedAmount?: number; cartDiscountAmount: number; channel?: string; closedAt?: Date; completedAt?: Date; createdAt: Date; currency: string; currentCartDiscountAmount: number; currentSubtotal?: number; currentSubtotalLineItemsQuantity?: number; currentTotalDiscounts: number; currentTotalPrice?: number; currentTotalTax?: number; customer?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; deliveryStatus?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; discountApplications?: object[]; discountCodes: string[]; dutiesRefundedAmount?: number; edited?: boolean; editedAt?: Date; email?: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed?: number; fulfilledAt?: Date; fulfillmentStatus: "SCHEDULED" | "UNFULFILLED" | "PARTIALLY_FULFILLED" | "FULFILLED" | "ON_HOLD"; giftCardAmountApplied?: number; giftCardCode?: string; giftCardsGenerated?: object[]; id: string; items: object[]; marketId?: string; netPayment?: number; notes?: string; orderNumber: string | number; paidAt?: Date; payment?: { amountPaid: number; amountRefunded: number; codeDiscount?: number; currency: string; discount: number; lineItemDiscount?: number; shipping: number; shippingBeforeDiscount?: number; shippingDiscount?: number; subtotal: number; tax: number; taxRate: number; total: number; totalPriceInStoreCurrency?: number; }; paymentMethod?: string; paymentStatus: "PENDING" | "EXPIRED" | "FAILED" | "REFUNDED" | "AUTHORIZED" | "PARTIALLY_PAID" | "PAID" | "CAPTURED" | "VOIDED" | "PARTIALLY_REFUNDED"; phone?: string; presentmentCurrency?: string; riskLevel?: "LOW" | "MEDIUM" | "HIGH"; riskScore?: number; shipping?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; carrier?: string; method: "NONE" | "SHIPPING" | "PICK_UP" | "LOCAL_DELIVERY" | "RETAIL"; shippingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; status?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; trackingNumber?: string; trackingUrl?: string; }; shippingRefundedAmount?: number; status: "PENDING" | "PROCESSING" | "COMPLETED" | "CANCELLED" | "CONFIRMED" | "SHIPPED" | "DELIVERED" | "REFUNDED"; storeId?: string; tags?: string[]; timeline?: object[]; totalOutstanding?: number; totalReceived?: number; totalRefunded?: number; updatedAt: Date; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:823

Parameters​

args​

...[string, object, string]

Returns​

Promise<{ draftOrder: { appliedDiscount: { amount?: number; description?: string; title: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes: object[]; autoApplyDiscounts: boolean; billingAddress: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; billingMatchesShipping: boolean; completedAt: Date; createdAt: Date; createdBy?: string; createdByName?: string; currency: string; customer: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; customerId: string; draftNumber: number; email: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed: number; id: string; invoiceEmailSubject: string; invoiceSentAt: Date; invoiceUrl: string; lineItems: object[]; market: { currency: string; id: string; name: string; }; marketId: string; metafields?: object[]; name: string; note: string; noteAttributes: object[]; order: { id: string; orderNumber: string; status: string; }; orderId: string; paymentTerms: { dueInDays: number; issueDate?: string; paymentDueDate?: string; type: string; }; phone: string; poNumber: string; presentmentCurrency: string; priceLocked: boolean; priceLockedAt: Date; reserveInventoryUntil: Date; shippingAddress: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; shippingLine: { custom?: boolean; handle?: string; price: number; title: string; }; sourceName?: string; status: "COMPLETED" | "OPEN" | "INVOICE_SENT"; storeId: string; subtotalPrice: number; tags: string[]; taxesIncluded: boolean; taxExempt: boolean; taxLines: object[]; timeline?: object[]; totalDiscount: number; totalPrice: number; totalPriceInStoreCurrency?: number; totalShipping: number; totalTax: number; updatedAt: Date; visibleToCustomer: boolean; }; order: { appliedDiscount?: { amount?: number; description?: string; title?: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes?: object[]; archivedAt?: Date; authorizedAmount?: number; autoApplyDiscounts?: boolean; billingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; cancelledAt?: Date; cancelledBy?: string; cancelledByName?: string; cancelNote?: string; cancelReason?: string; capturedAmount?: number; cartDiscountAmount: number; channel?: string; closedAt?: Date; completedAt?: Date; createdAt: Date; currency: string; currentCartDiscountAmount: number; currentSubtotal?: number; currentSubtotalLineItemsQuantity?: number; currentTotalDiscounts: number; currentTotalPrice?: number; currentTotalTax?: number; customer?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; deliveryStatus?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; discountApplications?: object[]; discountCodes: string[]; dutiesRefundedAmount?: number; edited?: boolean; editedAt?: Date; email?: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed?: number; fulfilledAt?: Date; fulfillmentStatus: "SCHEDULED" | "UNFULFILLED" | "PARTIALLY_FULFILLED" | "FULFILLED" | "ON_HOLD"; giftCardAmountApplied?: number; giftCardCode?: string; giftCardsGenerated?: object[]; id: string; items: object[]; marketId?: string; netPayment?: number; notes?: string; orderNumber: string | number; paidAt?: Date; payment?: { amountPaid: number; amountRefunded: number; codeDiscount?: number; currency: string; discount: number; lineItemDiscount?: number; shipping: number; shippingBeforeDiscount?: number; shippingDiscount?: number; subtotal: number; tax: number; taxRate: number; total: number; totalPriceInStoreCurrency?: number; }; paymentMethod?: string; paymentStatus: "PENDING" | "EXPIRED" | "FAILED" | "REFUNDED" | "AUTHORIZED" | "PARTIALLY_PAID" | "PAID" | "CAPTURED" | "VOIDED" | "PARTIALLY_REFUNDED"; phone?: string; presentmentCurrency?: string; riskLevel?: "LOW" | "MEDIUM" | "HIGH"; riskScore?: number; shipping?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; carrier?: string; method: "NONE" | "SHIPPING" | "PICK_UP" | "LOCAL_DELIVERY" | "RETAIL"; shippingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; status?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; trackingNumber?: string; trackingUrl?: string; }; shippingRefundedAmount?: number; status: "PENDING" | "PROCESSING" | "COMPLETED" | "CANCELLED" | "CONFIRMED" | "SHIPPED" | "DELIVERED" | "REFUNDED"; storeId?: string; tags?: string[]; timeline?: object[]; totalOutstanding?: number; totalReceived?: number; totalRefunded?: number; updatedAt: Date; }; }>

markFulfillmentOrderInProgress()​

markFulfillmentOrderInProgress(...args): Promise<FulfillmentOrder>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:404

Parameters​

args​

...[string, string, string]

Returns​

Promise<FulfillmentOrder>

markFulfillmentOrderUnfulfilled()​

markFulfillmentOrderUnfulfilled(...args): Promise<FulfillmentOrder>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:410

Parameters​

args​

...[string, string, string]

Returns​

Promise<FulfillmentOrder>

mergeFulfillmentOrders()​

mergeFulfillmentOrders(...args): Promise<{ deletedIds: string[]; merged: FulfillmentOrder; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:416

Parameters​

args​

...[string, string, MergeFulfillmentOrdersInput]

Returns​

Promise<{ deletedIds: string[]; merged: FulfillmentOrder; }>

moveFulfillmentOrder()​

moveFulfillmentOrder(...args): Promise<FulfillmentOrder>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:386

Parameters​

args​

...[string, string, string, MoveFulfillmentOrderInput]

Returns​

Promise<FulfillmentOrder>

orderUpdate()​

orderUpdate(...args): Promise<{ appliedDiscount?: { amount?: number; description?: string; title?: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes?: object[]; archivedAt?: Date; authorizedAmount?: number; autoApplyDiscounts?: boolean; billingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; cancelledAt?: Date; cancelledBy?: string; cancelledByName?: string; cancelNote?: string; cancelReason?: string; capturedAmount?: number; cartDiscountAmount: number; channel?: string; closedAt?: Date; completedAt?: Date; createdAt: Date; currency: string; currentCartDiscountAmount: number; currentSubtotal?: number; currentSubtotalLineItemsQuantity?: number; currentTotalDiscounts: number; currentTotalPrice?: number; currentTotalTax?: number; customer?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; deliveryStatus?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; discountApplications?: object[]; discountCodes: string[]; dutiesRefundedAmount?: number; edited?: boolean; editedAt?: Date; email?: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed?: number; fulfilledAt?: Date; fulfillmentStatus: "SCHEDULED" | "UNFULFILLED" | "PARTIALLY_FULFILLED" | "FULFILLED" | "ON_HOLD"; giftCardAmountApplied?: number; giftCardCode?: string; giftCardsGenerated?: object[]; id: string; items: object[]; marketId?: string; netPayment?: number; notes?: string; orderNumber: string | number; paidAt?: Date; payment?: { amountPaid: number; amountRefunded: number; codeDiscount?: number; currency: string; discount: number; lineItemDiscount?: number; shipping: number; shippingBeforeDiscount?: number; shippingDiscount?: number; subtotal: number; tax: number; taxRate: number; total: number; totalPriceInStoreCurrency?: number; }; paymentMethod?: string; paymentStatus: "PENDING" | "EXPIRED" | "FAILED" | "REFUNDED" | "AUTHORIZED" | "PARTIALLY_PAID" | "PAID" | "CAPTURED" | "VOIDED" | "PARTIALLY_REFUNDED"; phone?: string; presentmentCurrency?: string; riskLevel?: "LOW" | "MEDIUM" | "HIGH"; riskScore?: number; shipping?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; carrier?: string; method: "NONE" | "SHIPPING" | "PICK_UP" | "LOCAL_DELIVERY" | "RETAIL"; shippingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; status?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; trackingNumber?: string; trackingUrl?: string; }; shippingRefundedAmount?: number; status: "PENDING" | "PROCESSING" | "COMPLETED" | "CANCELLED" | "CONFIRMED" | "SHIPPED" | "DELIVERED" | "REFUNDED"; storeId?: string; tags?: string[]; timeline?: object[]; totalOutstanding?: number; totalReceived?: number; totalRefunded?: number; updatedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:70

Parameters​

args​

...[string, object, string]

Returns​

Promise<{ appliedDiscount?: { amount?: number; description?: string; title?: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes?: object[]; archivedAt?: Date; authorizedAmount?: number; autoApplyDiscounts?: boolean; billingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; cancelledAt?: Date; cancelledBy?: string; cancelledByName?: string; cancelNote?: string; cancelReason?: string; capturedAmount?: number; cartDiscountAmount: number; channel?: string; closedAt?: Date; completedAt?: Date; createdAt: Date; currency: string; currentCartDiscountAmount: number; currentSubtotal?: number; currentSubtotalLineItemsQuantity?: number; currentTotalDiscounts: number; currentTotalPrice?: number; currentTotalTax?: number; customer?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; deliveryStatus?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; discountApplications?: object[]; discountCodes: string[]; dutiesRefundedAmount?: number; edited?: boolean; editedAt?: Date; email?: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed?: number; fulfilledAt?: Date; fulfillmentStatus: "SCHEDULED" | "UNFULFILLED" | "PARTIALLY_FULFILLED" | "FULFILLED" | "ON_HOLD"; giftCardAmountApplied?: number; giftCardCode?: string; giftCardsGenerated?: object[]; id: string; items: object[]; marketId?: string; netPayment?: number; notes?: string; orderNumber: string | number; paidAt?: Date; payment?: { amountPaid: number; amountRefunded: number; codeDiscount?: number; currency: string; discount: number; lineItemDiscount?: number; shipping: number; shippingBeforeDiscount?: number; shippingDiscount?: number; subtotal: number; tax: number; taxRate: number; total: number; totalPriceInStoreCurrency?: number; }; paymentMethod?: string; paymentStatus: "PENDING" | "EXPIRED" | "FAILED" | "REFUNDED" | "AUTHORIZED" | "PARTIALLY_PAID" | "PAID" | "CAPTURED" | "VOIDED" | "PARTIALLY_REFUNDED"; phone?: string; presentmentCurrency?: string; riskLevel?: "LOW" | "MEDIUM" | "HIGH"; riskScore?: number; shipping?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; carrier?: string; method: "NONE" | "SHIPPING" | "PICK_UP" | "LOCAL_DELIVERY" | "RETAIL"; shippingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; status?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; trackingNumber?: string; trackingUrl?: string; }; shippingRefundedAmount?: number; status: "PENDING" | "PROCESSING" | "COMPLETED" | "CANCELLED" | "CONFIRMED" | "SHIPPED" | "DELIVERED" | "REFUNDED"; storeId?: string; tags?: string[]; timeline?: object[]; totalOutstanding?: number; totalReceived?: number; totalRefunded?: number; updatedAt: Date; }>

previewInvoice()​

previewInvoice(...args): Promise<{ from: string; html: string; subject: string; to: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:835

Parameters​

args​

...[string, SendInvoiceInput, string]

Returns​

Promise<{ from: string; html: string; subject: string; to: string; }>

processExchange()​

processExchange(...args): Promise<{ fulfillmentOrder: { id: string; name: string; onHold: boolean; status: string; }; return: ReturnWithDetails; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:628

Parameters​

args​

...[string, string, object]

Returns​

Promise<{ fulfillmentOrder: { id: string; name: string; onHold: boolean; status: string; }; return: ReturnWithDetails; }>

refund()​

refund(...args): Promise<{ order: { appliedDiscount?: { amount?: number; description?: string; title?: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes?: object[]; archivedAt?: Date; authorizedAmount?: number; autoApplyDiscounts?: boolean; billingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; cancelledAt?: Date; cancelledBy?: string; cancelledByName?: string; cancelNote?: string; cancelReason?: string; capturedAmount?: number; cartDiscountAmount: number; channel?: string; closedAt?: Date; completedAt?: Date; createdAt: Date; currency: string; currentCartDiscountAmount: number; currentSubtotal?: number; currentSubtotalLineItemsQuantity?: number; currentTotalDiscounts: number; currentTotalPrice?: number; currentTotalTax?: number; customer?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; deliveryStatus?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; discountApplications?: object[]; discountCodes: string[]; dutiesRefundedAmount?: number; edited?: boolean; editedAt?: Date; email?: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed?: number; fulfilledAt?: Date; fulfillmentStatus: "SCHEDULED" | "UNFULFILLED" | "PARTIALLY_FULFILLED" | "FULFILLED" | "ON_HOLD"; giftCardAmountApplied?: number; giftCardCode?: string; giftCardsGenerated?: object[]; id: string; items: object[]; marketId?: string; netPayment?: number; notes?: string; orderNumber: string | number; paidAt?: Date; payment?: { amountPaid: number; amountRefunded: number; codeDiscount?: number; currency: string; discount: number; lineItemDiscount?: number; shipping: number; shippingBeforeDiscount?: number; shippingDiscount?: number; subtotal: number; tax: number; taxRate: number; total: number; totalPriceInStoreCurrency?: number; }; paymentMethod?: string; paymentStatus: "PENDING" | "EXPIRED" | "FAILED" | "REFUNDED" | "AUTHORIZED" | "PARTIALLY_PAID" | "PAID" | "CAPTURED" | "VOIDED" | "PARTIALLY_REFUNDED"; phone?: string; presentmentCurrency?: string; riskLevel?: "LOW" | "MEDIUM" | "HIGH"; riskScore?: number; shipping?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; carrier?: string; method: "NONE" | "SHIPPING" | "PICK_UP" | "LOCAL_DELIVERY" | "RETAIL"; shippingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; status?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; trackingNumber?: string; trackingUrl?: string; }; shippingRefundedAmount?: number; status: "PENDING" | "PROCESSING" | "COMPLETED" | "CANCELLED" | "CONFIRMED" | "SHIPPED" | "DELIVERED" | "REFUNDED"; storeId?: string; tags?: string[]; timeline?: object[]; totalOutstanding?: number; totalReceived?: number; totalRefunded?: number; updatedAt: Date; }; refund: { id: string; lineItems?: unknown[]; transactions?: unknown[]; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:94

Parameters​

args​

...[string, object, string]

Returns​

Promise<{ order: { appliedDiscount?: { amount?: number; description?: string; title?: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes?: object[]; archivedAt?: Date; authorizedAmount?: number; autoApplyDiscounts?: boolean; billingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; cancelledAt?: Date; cancelledBy?: string; cancelledByName?: string; cancelNote?: string; cancelReason?: string; capturedAmount?: number; cartDiscountAmount: number; channel?: string; closedAt?: Date; completedAt?: Date; createdAt: Date; currency: string; currentCartDiscountAmount: number; currentSubtotal?: number; currentSubtotalLineItemsQuantity?: number; currentTotalDiscounts: number; currentTotalPrice?: number; currentTotalTax?: number; customer?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; deliveryStatus?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; discountApplications?: object[]; discountCodes: string[]; dutiesRefundedAmount?: number; edited?: boolean; editedAt?: Date; email?: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed?: number; fulfilledAt?: Date; fulfillmentStatus: "SCHEDULED" | "UNFULFILLED" | "PARTIALLY_FULFILLED" | "FULFILLED" | "ON_HOLD"; giftCardAmountApplied?: number; giftCardCode?: string; giftCardsGenerated?: object[]; id: string; items: object[]; marketId?: string; netPayment?: number; notes?: string; orderNumber: string | number; paidAt?: Date; payment?: { amountPaid: number; amountRefunded: number; codeDiscount?: number; currency: string; discount: number; lineItemDiscount?: number; shipping: number; shippingBeforeDiscount?: number; shippingDiscount?: number; subtotal: number; tax: number; taxRate: number; total: number; totalPriceInStoreCurrency?: number; }; paymentMethod?: string; paymentStatus: "PENDING" | "EXPIRED" | "FAILED" | "REFUNDED" | "AUTHORIZED" | "PARTIALLY_PAID" | "PAID" | "CAPTURED" | "VOIDED" | "PARTIALLY_REFUNDED"; phone?: string; presentmentCurrency?: string; riskLevel?: "LOW" | "MEDIUM" | "HIGH"; riskScore?: number; shipping?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; carrier?: string; method: "NONE" | "SHIPPING" | "PICK_UP" | "LOCAL_DELIVERY" | "RETAIL"; shippingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; status?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; trackingNumber?: string; trackingUrl?: string; }; shippingRefundedAmount?: number; status: "PENDING" | "PROCESSING" | "COMPLETED" | "CANCELLED" | "CONFIRMED" | "SHIPPED" | "DELIVERED" | "REFUNDED"; storeId?: string; tags?: string[]; timeline?: object[]; totalOutstanding?: number; totalReceived?: number; totalRefunded?: number; updatedAt: Date; }; refund: { id: string; lineItems?: unknown[]; transactions?: unknown[]; }; }>

releaseExchangeHold()​

releaseExchangeHold(...args): Promise<{ message: string; success: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:634

Parameters​

args​

...[string, string]

Returns​

Promise<{ message: string; success: boolean; }>

releaseHoldFulfillmentOrder()​

releaseHoldFulfillmentOrder(...args): Promise<FulfillmentOrder>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:374

Parameters​

args​

...[string, string, string]

Returns​

Promise<FulfillmentOrder>

removeOrderEditDiscount()​

removeOrderEditDiscount(...args): Promise<OrderEditWithDetails>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:701

Parameters​

args​

...[string, string, string]

Returns​

Promise<OrderEditWithDetails>

removeOrderEditLineItem()​

removeOrderEditLineItem(...args): Promise<OrderEditWithDetails>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:689

Parameters​

args​

...[string, string, RemoveOrderEditLineItemInput]

Returns​

Promise<OrderEditWithDetails>

removeReturnLabel()​

removeReturnLabel(...args): Promise<ReturnWithDetails>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:598

Parameters​

args​

...[string, string]

Returns​

Promise<ReturnWithDetails>

removeReturnLineItems()​

removeReturnLineItems(...args): Promise<ReturnWithDetails>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:562

Parameters​

args​

...[string, string, RemoveReturnLineItemsInput]

Returns​

Promise<ReturnWithDetails>

removeTracking()​

removeTracking(...args): Promise<void>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:471

Parameters​

args​

...[string, string, string, string]

Returns​

Promise<void>

reopenReturn()​

reopenReturn(...args): Promise<ReturnWithDetails>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:574

Parameters​

args​

...[string, string, ReopenReturnInput]

Returns​

Promise<ReturnWithDetails>

requestExchange()​

requestExchange(...args): Promise<ReturnWithDetails>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:616

Parameters​

args​

...[string, string, RequestExchangeInput]

Returns​

Promise<ReturnWithDetails>

requestReturn()​

requestReturn(...args): Promise<ReturnWithDetails>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:520

Parameters​

args​

...[string, string, RequestReturnInput]

Returns​

Promise<ReturnWithDetails>

rescheduleFulfillmentOrder()​

rescheduleFulfillmentOrder(...args): Promise<FulfillmentOrder>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:380

Parameters​

args​

...[string, string, string, RescheduleFulfillmentOrderInput]

Returns​

Promise<FulfillmentOrder>

resendTimelineNotification()​

resendTimelineNotification(...args): Promise<{ attachments?: object[]; authorId?: string; authorName?: string; createdAt: Date; description?: string; editedAt?: Date; id: string; isComment: boolean; isEdited: boolean; isSystem: boolean; mentions?: object[]; metadata?: Record<string, unknown>; timestamp: Date; title: string; type: "NOTIFICATION_SENT" | "NOTIFICATION_FAILED" | "NOTIFICATION_RESENT" | "TRACKING_ADDED" | "TRACKING_UPDATED" | "NOTE_ADDED" | "COMMENT" | "SHIPMENT_CREATED" | "ORDER_CANCELLED" | "ORDER_EDITED" | "REFUND_ISSUED" | "DELIVERED" | "ORDER_CREATED" | "ORDER_CONFIRMED" | "CONFIRMATION_GENERATED" | "ORDER_CLOSED" | "ORDER_REOPENED" | "ORDER_ARCHIVED" | "ORDER_UNARCHIVED" | "PAYMENT_CAPTURED" | "PAYMENT_FAILED" | "PAYMENT_PENDING" | "AUTHORIZATION_SUCCESS" | "AUTHORIZATION_PENDING" | "AUTHORIZATION_FAILURE" | "AUTHORIZATION_EXPIRED" | "VOID_SUCCESS" | "VOID_PENDING" | "VOID_FAILURE" | "SALE_SUCCESS" | "SALE_PENDING" | "SALE_FAILURE" | "FULFILLMENT_CREATED" | "FULFILLMENT_IN_PROGRESS" | "FULFILLMENT_UNFULFILLED" | "FULFILLMENT_HOLD" | "FULFILLMENT_RELEASED" | "FULFILLMENT_RELEASED_STATUS" | "FULFILLMENT_RESCHEDULED" | "FULFILLMENT_MOVED" | "FULFILLMENT_SPLIT" | "FULFILLMENT_MERGED" | "GIFT_CARD_FULFILLED" | "FULFILLMENT_CANCELLED" | "FULFILLMENT_PENDING" | "RESTOCK_LINE_ITEMS" | "REFUND_CREATED" | "REFUND_PROCESSED" | "REFUND_PENDING" | "REFUND_FAILED" | "RETURN_CREATED" | "RETURN_TRACKING_ADDED" | "RETURN_TRACKING_UPDATED" | "RETURN_LABEL_UPLOADED" | "RETURN_LABEL_REMOVED" | "RETURN_DECLINED" | "RETURN_CANCELLED" | "RETURN_ITEMS_RECEIVED" | "RETURN_PROCESSED" | "RETURN_CLOSED" | "RETURN_REOPENED" | "TRACKING_REMOVED" | "RISK_ASSESSED"; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:245

Parameters​

args​

...[string, string, string]

Returns​

Promise<{ attachments?: object[]; authorId?: string; authorName?: string; createdAt: Date; description?: string; editedAt?: Date; id: string; isComment: boolean; isEdited: boolean; isSystem: boolean; mentions?: object[]; metadata?: Record<string, unknown>; timestamp: Date; title: string; type: "NOTIFICATION_SENT" | "NOTIFICATION_FAILED" | "NOTIFICATION_RESENT" | "TRACKING_ADDED" | "TRACKING_UPDATED" | "NOTE_ADDED" | "COMMENT" | "SHIPMENT_CREATED" | "ORDER_CANCELLED" | "ORDER_EDITED" | "REFUND_ISSUED" | "DELIVERED" | "ORDER_CREATED" | "ORDER_CONFIRMED" | "CONFIRMATION_GENERATED" | "ORDER_CLOSED" | "ORDER_REOPENED" | "ORDER_ARCHIVED" | "ORDER_UNARCHIVED" | "PAYMENT_CAPTURED" | "PAYMENT_FAILED" | "PAYMENT_PENDING" | "AUTHORIZATION_SUCCESS" | "AUTHORIZATION_PENDING" | "AUTHORIZATION_FAILURE" | "AUTHORIZATION_EXPIRED" | "VOID_SUCCESS" | "VOID_PENDING" | "VOID_FAILURE" | "SALE_SUCCESS" | "SALE_PENDING" | "SALE_FAILURE" | "FULFILLMENT_CREATED" | "FULFILLMENT_IN_PROGRESS" | "FULFILLMENT_UNFULFILLED" | "FULFILLMENT_HOLD" | "FULFILLMENT_RELEASED" | "FULFILLMENT_RELEASED_STATUS" | "FULFILLMENT_RESCHEDULED" | "FULFILLMENT_MOVED" | "FULFILLMENT_SPLIT" | "FULFILLMENT_MERGED" | "GIFT_CARD_FULFILLED" | "FULFILLMENT_CANCELLED" | "FULFILLMENT_PENDING" | "RESTOCK_LINE_ITEMS" | "REFUND_CREATED" | "REFUND_PROCESSED" | "REFUND_PENDING" | "REFUND_FAILED" | "RETURN_CREATED" | "RETURN_TRACKING_ADDED" | "RETURN_TRACKING_UPDATED" | "RETURN_LABEL_UPLOADED" | "RETURN_LABEL_REMOVED" | "RETURN_DECLINED" | "RETURN_CANCELLED" | "RETURN_ITEMS_RECEIVED" | "RETURN_PROCESSED" | "RETURN_CLOSED" | "RETURN_REOPENED" | "TRACKING_REMOVED" | "RISK_ASSESSED"; }>

retrieve()​

retrieve(...args): Promise<{ appliedDiscount?: { amount?: number; description?: string; title?: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes?: object[]; archivedAt?: Date; authorizedAmount?: number; autoApplyDiscounts?: boolean; billingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; cancelledAt?: Date; cancelledBy?: string; cancelledByName?: string; cancelNote?: string; cancelReason?: string; capturedAmount?: number; cartDiscountAmount: number; channel?: string; closedAt?: Date; completedAt?: Date; createdAt: Date; currency: string; currentCartDiscountAmount: number; currentSubtotal?: number; currentSubtotalLineItemsQuantity?: number; currentTotalDiscounts: number; currentTotalPrice?: number; currentTotalTax?: number; customer?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; deliveryStatus?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; discountApplications?: object[]; discountCodes: string[]; dutiesRefundedAmount?: number; edited?: boolean; editedAt?: Date; email?: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed?: number; fulfilledAt?: Date; fulfillmentStatus: "SCHEDULED" | "UNFULFILLED" | "PARTIALLY_FULFILLED" | "FULFILLED" | "ON_HOLD"; giftCardAmountApplied?: number; giftCardCode?: string; giftCardsGenerated?: object[]; id: string; items: object[]; marketId?: string; netPayment?: number; notes?: string; orderNumber: string | number; paidAt?: Date; payment?: { amountPaid: number; amountRefunded: number; codeDiscount?: number; currency: string; discount: number; lineItemDiscount?: number; shipping: number; shippingBeforeDiscount?: number; shippingDiscount?: number; subtotal: number; tax: number; taxRate: number; total: number; totalPriceInStoreCurrency?: number; }; paymentMethod?: string; paymentStatus: "PENDING" | "EXPIRED" | "FAILED" | "REFUNDED" | "AUTHORIZED" | "PARTIALLY_PAID" | "PAID" | "CAPTURED" | "VOIDED" | "PARTIALLY_REFUNDED"; phone?: string; presentmentCurrency?: string; riskLevel?: "LOW" | "MEDIUM" | "HIGH"; riskScore?: number; shipping?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; carrier?: string; method: "NONE" | "SHIPPING" | "PICK_UP" | "LOCAL_DELIVERY" | "RETAIL"; shippingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; status?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; trackingNumber?: string; trackingUrl?: string; }; shippingRefundedAmount?: number; status: "PENDING" | "PROCESSING" | "COMPLETED" | "CANCELLED" | "CONFIRMED" | "SHIPPED" | "DELIVERED" | "REFUNDED"; storeId?: string; tags?: string[]; timeline?: object[]; totalOutstanding?: number; totalReceived?: number; totalRefunded?: number; updatedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:58

Parameters​

args​

...[string, string]

Returns​

Promise<{ appliedDiscount?: { amount?: number; description?: string; title?: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes?: object[]; archivedAt?: Date; authorizedAmount?: number; autoApplyDiscounts?: boolean; billingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; cancelledAt?: Date; cancelledBy?: string; cancelledByName?: string; cancelNote?: string; cancelReason?: string; capturedAmount?: number; cartDiscountAmount: number; channel?: string; closedAt?: Date; completedAt?: Date; createdAt: Date; currency: string; currentCartDiscountAmount: number; currentSubtotal?: number; currentSubtotalLineItemsQuantity?: number; currentTotalDiscounts: number; currentTotalPrice?: number; currentTotalTax?: number; customer?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; deliveryStatus?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; discountApplications?: object[]; discountCodes: string[]; dutiesRefundedAmount?: number; edited?: boolean; editedAt?: Date; email?: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed?: number; fulfilledAt?: Date; fulfillmentStatus: "SCHEDULED" | "UNFULFILLED" | "PARTIALLY_FULFILLED" | "FULFILLED" | "ON_HOLD"; giftCardAmountApplied?: number; giftCardCode?: string; giftCardsGenerated?: object[]; id: string; items: object[]; marketId?: string; netPayment?: number; notes?: string; orderNumber: string | number; paidAt?: Date; payment?: { amountPaid: number; amountRefunded: number; codeDiscount?: number; currency: string; discount: number; lineItemDiscount?: number; shipping: number; shippingBeforeDiscount?: number; shippingDiscount?: number; subtotal: number; tax: number; taxRate: number; total: number; totalPriceInStoreCurrency?: number; }; paymentMethod?: string; paymentStatus: "PENDING" | "EXPIRED" | "FAILED" | "REFUNDED" | "AUTHORIZED" | "PARTIALLY_PAID" | "PAID" | "CAPTURED" | "VOIDED" | "PARTIALLY_REFUNDED"; phone?: string; presentmentCurrency?: string; riskLevel?: "LOW" | "MEDIUM" | "HIGH"; riskScore?: number; shipping?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; carrier?: string; method: "NONE" | "SHIPPING" | "PICK_UP" | "LOCAL_DELIVERY" | "RETAIL"; shippingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; status?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; trackingNumber?: string; trackingUrl?: string; }; shippingRefundedAmount?: number; status: "PENDING" | "PROCESSING" | "COMPLETED" | "CANCELLED" | "CONFIRMED" | "SHIPPED" | "DELIVERED" | "REFUNDED"; storeId?: string; tags?: string[]; timeline?: object[]; totalOutstanding?: number; totalReceived?: number; totalRefunded?: number; updatedAt: Date; }>

retrieveAbandonedCheckout()​

retrieveAbandonedCheckout(...args): Promise<AbandonedCheckout>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:901

Parameters​

args​

...[string, string]

Returns​

Promise<AbandonedCheckout>

retrieveDraftOrder()​

retrieveDraftOrder(...args): Promise<{ appliedDiscount: { amount?: number; description?: string; title: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes: object[]; autoApplyDiscounts: boolean; billingAddress: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; billingMatchesShipping: boolean; completedAt: Date; createdAt: Date; createdBy?: string; createdByName?: string; currency: string; customer: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; customerId: string; draftNumber: number; email: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed: number; id: string; invoiceEmailSubject: string; invoiceSentAt: Date; invoiceUrl: string; lineItems: object[]; market: { currency: string; id: string; name: string; }; marketId: string; metafields?: object[]; name: string; note: string; noteAttributes: object[]; order: { id: string; orderNumber: string; status: string; }; orderId: string; paymentTerms: { dueInDays: number; issueDate?: string; paymentDueDate?: string; type: string; }; phone: string; poNumber: string; presentmentCurrency: string; priceLocked: boolean; priceLockedAt: Date; reserveInventoryUntil: Date; shippingAddress: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; shippingLine: { custom?: boolean; handle?: string; price: number; title: string; }; sourceName?: string; status: "COMPLETED" | "OPEN" | "INVOICE_SENT"; storeId: string; subtotalPrice: number; tags: string[]; taxesIncluded: boolean; taxExempt: boolean; taxLines: object[]; timeline?: object[]; totalDiscount: number; totalPrice: number; totalPriceInStoreCurrency?: number; totalShipping: number; totalTax: number; updatedAt: Date; visibleToCustomer: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:805

Parameters​

args​

...[string, string]

Returns​

Promise<{ appliedDiscount: { amount?: number; description?: string; title: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes: object[]; autoApplyDiscounts: boolean; billingAddress: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; billingMatchesShipping: boolean; completedAt: Date; createdAt: Date; createdBy?: string; createdByName?: string; currency: string; customer: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; customerId: string; draftNumber: number; email: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed: number; id: string; invoiceEmailSubject: string; invoiceSentAt: Date; invoiceUrl: string; lineItems: object[]; market: { currency: string; id: string; name: string; }; marketId: string; metafields?: object[]; name: string; note: string; noteAttributes: object[]; order: { id: string; orderNumber: string; status: string; }; orderId: string; paymentTerms: { dueInDays: number; issueDate?: string; paymentDueDate?: string; type: string; }; phone: string; poNumber: string; presentmentCurrency: string; priceLocked: boolean; priceLockedAt: Date; reserveInventoryUntil: Date; shippingAddress: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; shippingLine: { custom?: boolean; handle?: string; price: number; title: string; }; sourceName?: string; status: "COMPLETED" | "OPEN" | "INVOICE_SENT"; storeId: string; subtotalPrice: number; tags: string[]; taxesIncluded: boolean; taxExempt: boolean; taxLines: object[]; timeline?: object[]; totalDiscount: number; totalPrice: number; totalPriceInStoreCurrency?: number; totalShipping: number; totalTax: number; updatedAt: Date; visibleToCustomer: boolean; }>

returnProcess()​

returnProcess(...args): Promise<ReturnProcessResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:568

Parameters​

args​

...[string, string, ReturnProcessInput]

Returns​

Promise<ReturnProcessResponse>

searchDiscountCodes()​

searchDiscountCodes(...args): Promise<{ codes: object[]; total: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:877

Parameters​

args​

...[string, object]

Returns​

Promise<{ codes: object[]; total: number; }>

sendInvoice()​

sendInvoice(...args): Promise<{ draftOrder: { appliedDiscount: { amount?: number; description?: string; title: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes: object[]; autoApplyDiscounts: boolean; billingAddress: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; billingMatchesShipping: boolean; completedAt: Date; createdAt: Date; createdBy?: string; createdByName?: string; currency: string; customer: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; customerId: string; draftNumber: number; email: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed: number; id: string; invoiceEmailSubject: string; invoiceSentAt: Date; invoiceUrl: string; lineItems: object[]; market: { currency: string; id: string; name: string; }; marketId: string; metafields?: object[]; name: string; note: string; noteAttributes: object[]; order: { id: string; orderNumber: string; status: string; }; orderId: string; paymentTerms: { dueInDays: number; issueDate?: string; paymentDueDate?: string; type: string; }; phone: string; poNumber: string; presentmentCurrency: string; priceLocked: boolean; priceLockedAt: Date; reserveInventoryUntil: Date; shippingAddress: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; shippingLine: { custom?: boolean; handle?: string; price: number; title: string; }; sourceName?: string; status: "COMPLETED" | "OPEN" | "INVOICE_SENT"; storeId: string; subtotalPrice: number; tags: string[]; taxesIncluded: boolean; taxExempt: boolean; taxLines: object[]; timeline?: object[]; totalDiscount: number; totalPrice: number; totalPriceInStoreCurrency?: number; totalShipping: number; totalTax: number; updatedAt: Date; visibleToCustomer: boolean; }; invoiceUrl: string; sentTo: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:829

Parameters​

args​

...[string, SendInvoiceInput, string]

Returns​

Promise<{ draftOrder: { appliedDiscount: { amount?: number; description?: string; title: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes: object[]; autoApplyDiscounts: boolean; billingAddress: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; billingMatchesShipping: boolean; completedAt: Date; createdAt: Date; createdBy?: string; createdByName?: string; currency: string; customer: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; customerId: string; draftNumber: number; email: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed: number; id: string; invoiceEmailSubject: string; invoiceSentAt: Date; invoiceUrl: string; lineItems: object[]; market: { currency: string; id: string; name: string; }; marketId: string; metafields?: object[]; name: string; note: string; noteAttributes: object[]; order: { id: string; orderNumber: string; status: string; }; orderId: string; paymentTerms: { dueInDays: number; issueDate?: string; paymentDueDate?: string; type: string; }; phone: string; poNumber: string; presentmentCurrency: string; priceLocked: boolean; priceLockedAt: Date; reserveInventoryUntil: Date; shippingAddress: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; shippingLine: { custom?: boolean; handle?: string; price: number; title: string; }; sourceName?: string; status: "COMPLETED" | "OPEN" | "INVOICE_SENT"; storeId: string; subtotalPrice: number; tags: string[]; taxesIncluded: boolean; taxExempt: boolean; taxLines: object[]; timeline?: object[]; totalDiscount: number; totalPrice: number; totalPriceInStoreCurrency?: number; totalShipping: number; totalTax: number; updatedAt: Date; visibleToCustomer: boolean; }; invoiceUrl: string; sentTo: string; }>

sendOrderInvoice()​

sendOrderInvoice(...args): Promise<{ success: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:112

Parameters​

args​

...[string, object, string]

Returns​

Promise<{ success: boolean; }>

sendRecoveryEmail()​

sendRecoveryEmail(...args): Promise<{ sentAt: Date; success: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:907

Parameters​

args​

...[object, string]

Returns​

Promise<{ sentAt: Date; success: boolean; }>

splitFulfillmentOrder()​

splitFulfillmentOrder(...args): Promise<SplitFulfillmentOrderResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:392

Parameters​

args​

...[string, string, string, SplitFulfillmentOrderInput]

Returns​

Promise<SplitFulfillmentOrderResponse>

syncFulfillmentTracking()​

syncFulfillmentTracking(...args): Promise<{ fulfillment: { createdAt: Date; id: string; items: object[]; status: "partial" | "fulfilled" | "unfulfilled"; trackingInfo?: { company?: string; number: string; url?: string; }; }; message?: string; newEvents: FulfillmentEvent[]; synced: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:489

Parameters​

args​

...[string, string, string, object]

Returns​

Promise<{ fulfillment: { createdAt: Date; id: string; items: object[]; status: "partial" | "fulfilled" | "unfulfilled"; trackingInfo?: { company?: string; number: string; url?: string; }; }; message?: string; newEvents: FulfillmentEvent[]; synced: boolean; }>

unarchive()​

unarchive(...args): Promise<{ appliedDiscount?: { amount?: number; description?: string; title?: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes?: object[]; archivedAt?: Date; authorizedAmount?: number; autoApplyDiscounts?: boolean; billingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; cancelledAt?: Date; cancelledBy?: string; cancelledByName?: string; cancelNote?: string; cancelReason?: string; capturedAmount?: number; cartDiscountAmount: number; channel?: string; closedAt?: Date; completedAt?: Date; createdAt: Date; currency: string; currentCartDiscountAmount: number; currentSubtotal?: number; currentSubtotalLineItemsQuantity?: number; currentTotalDiscounts: number; currentTotalPrice?: number; currentTotalTax?: number; customer?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; deliveryStatus?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; discountApplications?: object[]; discountCodes: string[]; dutiesRefundedAmount?: number; edited?: boolean; editedAt?: Date; email?: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed?: number; fulfilledAt?: Date; fulfillmentStatus: "SCHEDULED" | "UNFULFILLED" | "PARTIALLY_FULFILLED" | "FULFILLED" | "ON_HOLD"; giftCardAmountApplied?: number; giftCardCode?: string; giftCardsGenerated?: object[]; id: string; items: object[]; marketId?: string; netPayment?: number; notes?: string; orderNumber: string | number; paidAt?: Date; payment?: { amountPaid: number; amountRefunded: number; codeDiscount?: number; currency: string; discount: number; lineItemDiscount?: number; shipping: number; shippingBeforeDiscount?: number; shippingDiscount?: number; subtotal: number; tax: number; taxRate: number; total: number; totalPriceInStoreCurrency?: number; }; paymentMethod?: string; paymentStatus: "PENDING" | "EXPIRED" | "FAILED" | "REFUNDED" | "AUTHORIZED" | "PARTIALLY_PAID" | "PAID" | "CAPTURED" | "VOIDED" | "PARTIALLY_REFUNDED"; phone?: string; presentmentCurrency?: string; riskLevel?: "LOW" | "MEDIUM" | "HIGH"; riskScore?: number; shipping?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; carrier?: string; method: "NONE" | "SHIPPING" | "PICK_UP" | "LOCAL_DELIVERY" | "RETAIL"; shippingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; status?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; trackingNumber?: string; trackingUrl?: string; }; shippingRefundedAmount?: number; status: "PENDING" | "PROCESSING" | "COMPLETED" | "CANCELLED" | "CONFIRMED" | "SHIPPED" | "DELIVERED" | "REFUNDED"; storeId?: string; tags?: string[]; timeline?: object[]; totalOutstanding?: number; totalReceived?: number; totalRefunded?: number; updatedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:106

Parameters​

args​

...[string, string]

Returns​

Promise<{ appliedDiscount?: { amount?: number; description?: string; title?: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes?: object[]; archivedAt?: Date; authorizedAmount?: number; autoApplyDiscounts?: boolean; billingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; cancelledAt?: Date; cancelledBy?: string; cancelledByName?: string; cancelNote?: string; cancelReason?: string; capturedAmount?: number; cartDiscountAmount: number; channel?: string; closedAt?: Date; completedAt?: Date; createdAt: Date; currency: string; currentCartDiscountAmount: number; currentSubtotal?: number; currentSubtotalLineItemsQuantity?: number; currentTotalDiscounts: number; currentTotalPrice?: number; currentTotalTax?: number; customer?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; deliveryStatus?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; discountApplications?: object[]; discountCodes: string[]; dutiesRefundedAmount?: number; edited?: boolean; editedAt?: Date; email?: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed?: number; fulfilledAt?: Date; fulfillmentStatus: "SCHEDULED" | "UNFULFILLED" | "PARTIALLY_FULFILLED" | "FULFILLED" | "ON_HOLD"; giftCardAmountApplied?: number; giftCardCode?: string; giftCardsGenerated?: object[]; id: string; items: object[]; marketId?: string; netPayment?: number; notes?: string; orderNumber: string | number; paidAt?: Date; payment?: { amountPaid: number; amountRefunded: number; codeDiscount?: number; currency: string; discount: number; lineItemDiscount?: number; shipping: number; shippingBeforeDiscount?: number; shippingDiscount?: number; subtotal: number; tax: number; taxRate: number; total: number; totalPriceInStoreCurrency?: number; }; paymentMethod?: string; paymentStatus: "PENDING" | "EXPIRED" | "FAILED" | "REFUNDED" | "AUTHORIZED" | "PARTIALLY_PAID" | "PAID" | "CAPTURED" | "VOIDED" | "PARTIALLY_REFUNDED"; phone?: string; presentmentCurrency?: string; riskLevel?: "LOW" | "MEDIUM" | "HIGH"; riskScore?: number; shipping?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; carrier?: string; method: "NONE" | "SHIPPING" | "PICK_UP" | "LOCAL_DELIVERY" | "RETAIL"; shippingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; status?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; trackingNumber?: string; trackingUrl?: string; }; shippingRefundedAmount?: number; status: "PENDING" | "PROCESSING" | "COMPLETED" | "CANCELLED" | "CONFIRMED" | "SHIPPED" | "DELIVERED" | "REFUNDED"; storeId?: string; tags?: string[]; timeline?: object[]; totalOutstanding?: number; totalReceived?: number; totalRefunded?: number; updatedAt: Date; }>

updateDraftOrder()​

updateDraftOrder(...args): Promise<{ appliedDiscount: { amount?: number; description?: string; title: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes: object[]; autoApplyDiscounts: boolean; billingAddress: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; billingMatchesShipping: boolean; completedAt: Date; createdAt: Date; createdBy?: string; createdByName?: string; currency: string; customer: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; customerId: string; draftNumber: number; email: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed: number; id: string; invoiceEmailSubject: string; invoiceSentAt: Date; invoiceUrl: string; lineItems: object[]; market: { currency: string; id: string; name: string; }; marketId: string; metafields?: object[]; name: string; note: string; noteAttributes: object[]; order: { id: string; orderNumber: string; status: string; }; orderId: string; paymentTerms: { dueInDays: number; issueDate?: string; paymentDueDate?: string; type: string; }; phone: string; poNumber: string; presentmentCurrency: string; priceLocked: boolean; priceLockedAt: Date; reserveInventoryUntil: Date; shippingAddress: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; shippingLine: { custom?: boolean; handle?: string; price: number; title: string; }; sourceName?: string; status: "COMPLETED" | "OPEN" | "INVOICE_SENT"; storeId: string; subtotalPrice: number; tags: string[]; taxesIncluded: boolean; taxExempt: boolean; taxLines: object[]; timeline?: object[]; totalDiscount: number; totalPrice: number; totalPriceInStoreCurrency?: number; totalShipping: number; totalTax: number; updatedAt: Date; visibleToCustomer: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:817

Parameters​

args​

...[string, object, string]

Returns​

Promise<{ appliedDiscount: { amount?: number; description?: string; title: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes: object[]; autoApplyDiscounts: boolean; billingAddress: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; billingMatchesShipping: boolean; completedAt: Date; createdAt: Date; createdBy?: string; createdByName?: string; currency: string; customer: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; customerId: string; draftNumber: number; email: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed: number; id: string; invoiceEmailSubject: string; invoiceSentAt: Date; invoiceUrl: string; lineItems: object[]; market: { currency: string; id: string; name: string; }; marketId: string; metafields?: object[]; name: string; note: string; noteAttributes: object[]; order: { id: string; orderNumber: string; status: string; }; orderId: string; paymentTerms: { dueInDays: number; issueDate?: string; paymentDueDate?: string; type: string; }; phone: string; poNumber: string; presentmentCurrency: string; priceLocked: boolean; priceLockedAt: Date; reserveInventoryUntil: Date; shippingAddress: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; shippingLine: { custom?: boolean; handle?: string; price: number; title: string; }; sourceName?: string; status: "COMPLETED" | "OPEN" | "INVOICE_SENT"; storeId: string; subtotalPrice: number; tags: string[]; taxesIncluded: boolean; taxExempt: boolean; taxLines: object[]; timeline?: object[]; totalDiscount: number; totalPrice: number; totalPriceInStoreCurrency?: number; totalShipping: number; totalTax: number; updatedAt: Date; visibleToCustomer: boolean; }>

updateOrderEditQuantity()​

updateOrderEditQuantity(...args): Promise<OrderEditWithDetails>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:683

Parameters​

args​

...[string, string, UpdateOrderEditLineItemQuantityInput]

Returns​

Promise<OrderEditWithDetails>

updateOrderRisk()​

updateOrderRisk(...args): Promise<{ assessedAt: Date; causeCancel: boolean; checkoutId: string; createdAt: Date; customerRisk?: { accountAgeDays?: number; chargebackCount?: number; isNewCustomer?: boolean; orderCount?: number; }; deviceRisk?: { browserFingerprint?: string; deviceId?: string; deviceType?: string; userAgent?: string; }; display: boolean; emailRisk?: { disposableEmail?: boolean; emailDomainAgeDays?: number; }; id: string; indicators?: object[]; ipRisk?: { city?: string; country?: string; ipAddress?: string; isProxy?: boolean; isTorExitNode?: boolean; isVpn?: boolean; riskScore?: number; }; level: "LOW" | "MEDIUM" | "HIGH"; merchantNote: string; message: string; orderId: string; orderRisk?: { differentShipBillAddress?: boolean; expeditedShipping?: boolean; failedPaymentAttempts?: number; highValueOrder?: boolean; multipleQuantitySameItem?: boolean; unusualTimeOfDay?: boolean; }; paymentRisk?: { avsResultCode?: string; billingCountryMatchesCard?: boolean; cardBin?: string; cardCountry?: string; cardIssuer?: string; cvvResultCode?: string; shippingCountryMatchesCard?: boolean; }; recommendation: "CANCEL" | "ACCEPT" | "INVESTIGATE"; score: number; source: string; storeId: string; updatedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:756

Parameters​

args​

...[string, string, object]

Returns​

Promise<{ assessedAt: Date; causeCancel: boolean; checkoutId: string; createdAt: Date; customerRisk?: { accountAgeDays?: number; chargebackCount?: number; isNewCustomer?: boolean; orderCount?: number; }; deviceRisk?: { browserFingerprint?: string; deviceId?: string; deviceType?: string; userAgent?: string; }; display: boolean; emailRisk?: { disposableEmail?: boolean; emailDomainAgeDays?: number; }; id: string; indicators?: object[]; ipRisk?: { city?: string; country?: string; ipAddress?: string; isProxy?: boolean; isTorExitNode?: boolean; isVpn?: boolean; riskScore?: number; }; level: "LOW" | "MEDIUM" | "HIGH"; merchantNote: string; message: string; orderId: string; orderRisk?: { differentShipBillAddress?: boolean; expeditedShipping?: boolean; failedPaymentAttempts?: number; highValueOrder?: boolean; multipleQuantitySameItem?: boolean; unusualTimeOfDay?: boolean; }; paymentRisk?: { avsResultCode?: string; billingCountryMatchesCard?: boolean; cardBin?: string; cardCountry?: string; cardIssuer?: string; cvvResultCode?: string; shippingCountryMatchesCard?: boolean; }; recommendation: "CANCEL" | "ACCEPT" | "INVESTIGATE"; score: number; source: string; storeId: string; updatedAt: Date; }>

updateReturnTracking()​

updateReturnTracking(...args): Promise<ReturnWithDetails>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:586

Parameters​

args​

...[string, string, object]

Returns​

Promise<ReturnWithDetails>

updateStatus()​

updateStatus(...args): Promise<{ appliedDiscount?: { amount?: number; description?: string; title?: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes?: object[]; archivedAt?: Date; authorizedAmount?: number; autoApplyDiscounts?: boolean; billingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; cancelledAt?: Date; cancelledBy?: string; cancelledByName?: string; cancelNote?: string; cancelReason?: string; capturedAmount?: number; cartDiscountAmount: number; channel?: string; closedAt?: Date; completedAt?: Date; createdAt: Date; currency: string; currentCartDiscountAmount: number; currentSubtotal?: number; currentSubtotalLineItemsQuantity?: number; currentTotalDiscounts: number; currentTotalPrice?: number; currentTotalTax?: number; customer?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; deliveryStatus?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; discountApplications?: object[]; discountCodes: string[]; dutiesRefundedAmount?: number; edited?: boolean; editedAt?: Date; email?: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed?: number; fulfilledAt?: Date; fulfillmentStatus: "SCHEDULED" | "UNFULFILLED" | "PARTIALLY_FULFILLED" | "FULFILLED" | "ON_HOLD"; giftCardAmountApplied?: number; giftCardCode?: string; giftCardsGenerated?: object[]; id: string; items: object[]; marketId?: string; netPayment?: number; notes?: string; orderNumber: string | number; paidAt?: Date; payment?: { amountPaid: number; amountRefunded: number; codeDiscount?: number; currency: string; discount: number; lineItemDiscount?: number; shipping: number; shippingBeforeDiscount?: number; shippingDiscount?: number; subtotal: number; tax: number; taxRate: number; total: number; totalPriceInStoreCurrency?: number; }; paymentMethod?: string; paymentStatus: "PENDING" | "EXPIRED" | "FAILED" | "REFUNDED" | "AUTHORIZED" | "PARTIALLY_PAID" | "PAID" | "CAPTURED" | "VOIDED" | "PARTIALLY_REFUNDED"; phone?: string; presentmentCurrency?: string; riskLevel?: "LOW" | "MEDIUM" | "HIGH"; riskScore?: number; shipping?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; carrier?: string; method: "NONE" | "SHIPPING" | "PICK_UP" | "LOCAL_DELIVERY" | "RETAIL"; shippingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; status?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; trackingNumber?: string; trackingUrl?: string; }; shippingRefundedAmount?: number; status: "PENDING" | "PROCESSING" | "COMPLETED" | "CANCELLED" | "CONFIRMED" | "SHIPPED" | "DELIVERED" | "REFUNDED"; storeId?: string; tags?: string[]; timeline?: object[]; totalOutstanding?: number; totalReceived?: number; totalRefunded?: number; updatedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:82

Parameters​

args​

...[string, OrderStatus, string]

Returns​

Promise<{ appliedDiscount?: { amount?: number; description?: string; title?: string; value: number; valueType: "PERCENTAGE" | "FIXED_AMOUNT"; }; appliedDiscountCodes?: object[]; archivedAt?: Date; authorizedAmount?: number; autoApplyDiscounts?: boolean; billingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; cancelledAt?: Date; cancelledBy?: string; cancelledByName?: string; cancelNote?: string; cancelReason?: string; capturedAmount?: number; cartDiscountAmount: number; channel?: string; closedAt?: Date; completedAt?: Date; createdAt: Date; currency: string; currentCartDiscountAmount: number; currentSubtotal?: number; currentSubtotalLineItemsQuantity?: number; currentTotalDiscounts: number; currentTotalPrice?: number; currentTotalTax?: number; customer?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; email: string; firstName: string; id: string; lastName: string; name: string; orderCount?: number; phone?: string; }; deliveryStatus?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; discountApplications?: object[]; discountCodes: string[]; dutiesRefundedAmount?: number; edited?: boolean; editedAt?: Date; email?: string; exchangeRatesSnapshot?: { capturedAt: string; rates: object & Record<string, number>; transaction: { from: string; rate: number; rateId?: string; source: "MANUAL" | "DYNAMIC"; to: string; }; }; exchangeRateUsed?: number; fulfilledAt?: Date; fulfillmentStatus: "SCHEDULED" | "UNFULFILLED" | "PARTIALLY_FULFILLED" | "FULFILLED" | "ON_HOLD"; giftCardAmountApplied?: number; giftCardCode?: string; giftCardsGenerated?: object[]; id: string; items: object[]; marketId?: string; netPayment?: number; notes?: string; orderNumber: string | number; paidAt?: Date; payment?: { amountPaid: number; amountRefunded: number; codeDiscount?: number; currency: string; discount: number; lineItemDiscount?: number; shipping: number; shippingBeforeDiscount?: number; shippingDiscount?: number; subtotal: number; tax: number; taxRate: number; total: number; totalPriceInStoreCurrency?: number; }; paymentMethod?: string; paymentStatus: "PENDING" | "EXPIRED" | "FAILED" | "REFUNDED" | "AUTHORIZED" | "PARTIALLY_PAID" | "PAID" | "CAPTURED" | "VOIDED" | "PARTIALLY_REFUNDED"; phone?: string; presentmentCurrency?: string; riskLevel?: "LOW" | "MEDIUM" | "HIGH"; riskScore?: number; shipping?: { address?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; carrier?: string; method: "NONE" | "SHIPPING" | "PICK_UP" | "LOCAL_DELIVERY" | "RETAIL"; shippingAddress?: { address1: string; address2?: string; city: string; company?: string; country: string; firstName: string; lastName: string; phone?: string; postalCode: string; province: string; }; status?: "PENDING" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "ATTEMPTED_DELIVERY" | "READY_FOR_PICKUP" | "PICKED_UP"; trackingNumber?: string; trackingUrl?: string; }; shippingRefundedAmount?: number; status: "PENDING" | "PROCESSING" | "COMPLETED" | "CANCELLED" | "CONFIRMED" | "SHIPPED" | "DELIVERED" | "REFUNDED"; storeId?: string; tags?: string[]; timeline?: object[]; totalOutstanding?: number; totalReceived?: number; totalRefunded?: number; updatedAt: Date; }>

updateTrackingStatus()​

updateTrackingStatus(...args): Promise<{ carrierId?: string; carrierInfo?: { alias?: string; country?: string; homepage?: string; key: number; name: string; }; createdAt: Date; daysInTransit?: number; deliveredAt?: Date; estimatedDeliveryAt?: Date; events?: object[]; fulfillmentId: string; id: string; lastTrackingSync?: Date; milestones?: object[]; registeredAt?: Date; registrationError?: string; registrationStatus: "PENDING" | "EXPIRED" | "FAILED" | "ACTIVE" | "REGISTERED"; shipmentStatus: "PENDING" | "EXPIRED" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "INFO_RECEIVED" | "FAILED_ATTEMPT" | "EXCEPTION" | "RETURNED_TO_SENDER"; shippedAt?: Date; shippingInfo?: { recipientAddress?: { city?: string; coordinates?: { latitude?: number; longitude?: number; }; country?: string; postalCode?: string; state?: string; street?: string; }; shipperAddress?: { city?: string; coordinates?: { latitude?: number; longitude?: number; }; country?: string; postalCode?: string; state?: string; street?: string; }; }; storeId: string; syncCount: number; timeMetrics?: { daysAfterLastUpdate?: number; daysAfterOrder?: number; daysOfTransit?: number; daysOfTransitDone?: number; estimatedDeliveryDate?: { from?: Date; source?: string; to?: Date; }; }; trackingCompany?: string; trackingNumber: string; trackingSource?: string; trackingUrl?: string; updatedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:459

Parameters​

args​

...[string, string, string, string, object]

Returns​

Promise<{ carrierId?: string; carrierInfo?: { alias?: string; country?: string; homepage?: string; key: number; name: string; }; createdAt: Date; daysInTransit?: number; deliveredAt?: Date; estimatedDeliveryAt?: Date; events?: object[]; fulfillmentId: string; id: string; lastTrackingSync?: Date; milestones?: object[]; registeredAt?: Date; registrationError?: string; registrationStatus: "PENDING" | "EXPIRED" | "FAILED" | "ACTIVE" | "REGISTERED"; shipmentStatus: "PENDING" | "EXPIRED" | "IN_TRANSIT" | "DELIVERED" | "OUT_FOR_DELIVERY" | "INFO_RECEIVED" | "FAILED_ATTEMPT" | "EXCEPTION" | "RETURNED_TO_SENDER"; shippedAt?: Date; shippingInfo?: { recipientAddress?: { city?: string; coordinates?: { latitude?: number; longitude?: number; }; country?: string; postalCode?: string; state?: string; street?: string; }; shipperAddress?: { city?: string; coordinates?: { latitude?: number; longitude?: number; }; country?: string; postalCode?: string; state?: string; street?: string; }; }; storeId: string; syncCount: number; timeMetrics?: { daysAfterLastUpdate?: number; daysAfterOrder?: number; daysOfTransit?: number; daysOfTransitDone?: number; estimatedDeliveryDate?: { from?: Date; source?: string; to?: Date; }; }; trackingCompany?: string; trackingNumber: string; trackingSource?: string; trackingUrl?: string; updatedAt: Date; }>

updateTransactionStatus()​

updateTransactionStatus(...args): Promise<OrderTransaction>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:306

Parameters​

args​

...[string, string, string, UpdateTransactionStatusInput]

Returns​

Promise<OrderTransaction>

uploadReturnLabel()​

uploadReturnLabel(...args): Promise<ReturnWithDetails>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:592

Parameters​

args​

...[string, string, object]

Returns​

Promise<ReturnWithDetails>

validateDiscountCodes()​

validateDiscountCodes(...args): Promise<{ results: object[]; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:871

Parameters​

args​

...[string, object]

Returns​

Promise<{ results: object[]; }>

voidAuthorization()​

voidAuthorization(...args): Promise<VoidPaymentResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/orders.ts:294

Parameters​

args​

...[string, string, string, VoidPaymentInput]

Returns​

Promise<VoidPaymentResponse>