API Schemas

You can use these schemas as a reference when preparing API request messages. Click or tap the link to open a schema in a new window.

Address Validation

• Address-Validation-Datatypes-1.0.xsd
• Address-Validation-Service-1.0.xsd

Inventory

• Inventory-Datatypes-1.0.xsd
• Inventory-Service-Allocation-1.0.xsd
• Inventory-Service-AssociateDeliveryEligibility-1.0.xsd
• Inventory-Service-InStoreQuantity-1.0.xsd
• Inventory-Service-InventoryDetails-1.0.xsd
• Inventory-Service-Quantity-1.0.xsd
• Inventory-Service-Quantity-Details-1.0.xsd
• Inventory-Service-RollbackAllocation-1.0.xsd
• Inventory-Service-SFSItemAdjustInventory-1.0.xsd

Notification Events

• Batch-Events-1.0.xsd

• FulfillmentOrder-Common-SLA-Event-1.0.xsd

• FulfillmentOrder-Customer-Delivery-SLA-Event-1.0.xsd

• FulfillmentOrder-Customer-Pickup-SLA-Event-1.0.xsd

• FulfillmentOrder-Pack-Complete-SLA-Event-1.0.xsd

• FulfillmentOrder-Pick-Complete-SLA-Event-1.0.xsd

• FulfillmentOrder-Pick-Start-SLA-Event-1.0.xsd

• Order-Accepted-Event-1.0.xsd

• Order-Backorder-Event-1.0.xsd

• Order-Cancel-Event-1.0.xsd

• Order-Common-Event-1.0.xsd
• Order-Completion-Event-1.0.xsd

• Order-Confirmed-Event-1.0.xsd

• Order-CreditIssued-Event-1.0.xsd

• Order-GiftCardActivation-Event-1.0.xsd

• Order-Pickup-Complete-Event-1.0.xsd

• Order-Pickup-Ready-Event-1.0.xsd

• Order-Pickup-Reminder-Event-1.0.xsd

• Order-PriceAdjustment-Event-1.0.xsd
• Order-Rejected-Event-1.0.xsd

• Order-Return-InTransit-Event-1.0.xsd

• Order-Shipping-Event-1.0.xsd

• Payment-Service-Vault-Expired-Tender-Event-1.0.xsd
• Rma-Confirmed-Event.1.0.xsd

Order

• Bulk-Order-Service-Create-1.0.xsd
• Order-Datatypes-Common-1.0.xsd
• Order-Service-Cancel-1.0.xsd
• Order-Service-Create-1.0.xsd
• Order-Service-Create-Bulk-1.0.xsd
• Order-Service-Detail-1.0.xsd
• Order-Service-GiftSearch-1.0.xsd
• Order-Service-Hold-Request-1.0.xsd
• Order-Service-Hold-Response-1.0.xsd
• Order-Service-Invoice-1.0.xsd
• Order-Service-InvoiceSearch-1.0.xsd
• Order-Service-LineCancel-1.0.xsd
• Order-Service-PriceAdjustment-1.0.xsd
• Order-Service-RelatedOrderSearch-1.0.xsd
• Order-Service-ReturnLabels-1.0.xsd
• Order-Service-Search-1.0.xsd
• Order-Service-Update-Request-1.0.xsd
• Order-Service-Update-Response-1.0.xsd
• Reship-Create-1.0.xsd
• Reship-Info-1.0.xsd

Payment

• Checkout-Datatypes-1.0.xsd
• Checkout-Service-Fault-1.0.xsd
• DecryptBlobReply.xsd
• DecryptBlobRequest.xsd
• Payment-Datatypes-1.0.xsd
• Payment-Datatypes-CurrencyCode-1.0.xsd
• Payment-Service-AlipayGetPayment-1.0.xsd
• Payment-Service-AlipayPaymentStatus-1.0.xsd
• Payment-Service-AuthValidation-1.0.xsd
• Payment-Service-BankTransfer-1.0.xsd
• Payment-Service-Bml-Process-1.0.xsd
• Payment-Service-Bml-Set-1.0.xsd
• Payment-Service-Bml-Status-1.0.xsd
• Payment-Service-ConfirmFunds-1.0.xsd
• Payment-Service-CreditCardAuth-1.0.xsd
• Payment-Service-DecryptBlob-1.0.xsd
• Payment-Service-InstantLoanAuth-1.0.xsd
• Payment-Service-OpenInvoice-1.0.xsd
• Payment-Service-OpenInvoiceList-1.0.xsd
• Payment-Service-PaymentAuthCancel-1.0.xsd
• Payment-Service-PaymentAuthCancelList-1.0.xsd
• Payment-Service-PaymentSettlement-1.0.xsd
• Payment-Service-PaymentSettlementList-1.0.xsd
• Payment-Service-PayPalCreateBillingAgreement-1.0.xsd
• Payment-Service-PayPalDoAuth-1.0.xsd
• Payment-Service-PayPalDoExpress-1.0.xsd
• Payment-Service-PayPalDoReferenceTransaction-1.0.xsd
• Payment-Service-PayPalGetExpress-1.0.xsd
• Payment-Service-PayPalSetExpress-1.0.xsd
• Payment-Service-UpdateAuth-1.0.xsd
• Payment-Service-PayPalVoidAuth-1.0.xsd
• Payment-Service-PlccAuth-1.0.xsd
• Payment-Service-ProtectPan-1.0.xsd
• Payment-Service-PublicKey-1.0.xsd
• Payment-Service-RevealPan-1.0.xsd
• Payment-Service-StoredValueBalance-1.0.xsd
• Payment-Service-StoredValueCashOut-1.0.xsd
• Payment-Service-StoredValueFund-1.0.xsd
• Payment-Service-StoredValueFundAndActivate-1.0.xsd
• Payment-Service-StoredValueRedeem-1.0.xsd
• Payment-Service-StoredValueRedeemVoid-1.0.xsd
• Payment-Service-TenderTypeLookup-1.0.xsd
• Payment-Service-TermsAndConditions-1.0.xsd
• Payment-Service-ThreeDSecureEnrollmentEligibility-1.0.xsd
• Payment-Service-TransactionHistory-1.0.xsd
• Payment-Service-ValidateCard-1.0.xsd
• Payment-Service-VaultAddCreditCard-1.0.xsd
• Payment-Service-VaultAddCreditCardRequest-1.0.xsd
• Payment-Service-VaultAddPayPal-1.0.xsd
• Payment-Service-VaultAddStoredValue-1.0.xsd
• Payment-Service-VaultCreate-1.0.xsd
• Payment-Service-Vault-Expired-Tender-Event-1.0.xsd
• Payment-Service-VaultPayment-1.0.xsd
• Payment-Service-VaultPaymentVoid-1.0.xsd
• Payment-Service-VaultTenderDelete-1.0.xsd
• Payment-Service-VaultTenders-1.0.xsd
• Payment-Service-VaultUpdate-1.0.xsd
• Payment-Service-VaultUpdateCreditCard-1.0.xsd
• Payment-Service-VaultUpdatePayPal-1.0.xsd
• Payment-Service-VaultUpdateStoredValue-1.0.xsd

Risk

• Risk-OrderConfirmationReply-1.0.xsd
• Risk-OrderConfirmationRequest-1.0.xsd
• Risk-OrderResponseResend-1.0.xsd
• Risk-OrderStatus-1.0.xsd
• Risk-Service-Datatypes-1.0.xsd
• Risk-Service-RiskAssessment-1.0.xsd
• Risk-Service-RiskAssessmentList-1.0.xsd

Shipment

• Shipment-Service-Fault-1.0.xsd
• Shipment-Service-Tracking-Request-1.0.xsd
• Shipment-Service-Tracking-Response-1.0.xsd
• Shipping-Destination-Restriction-Request-1.0.xsd
• Shipping-Destination-Restriction-Response-1.0.xsd
• Shipping-Restriction-Datatypes-1.0.xsd
• Shipping-Restriction-Request-1.0.xsd
• Shipping-Restriction-Response-1.0.xsd

Subscription

• Subscription-Service-Cancel-1.0.xsd
• Subscription-Service-Fault-1.0.xsd
• Subscription-Service-Search-1.0.xsd
• Subscription-Service-Tenders-Add-1.0.xsd
• Subscription-Service-Tenders-Delete-1.0.xsd
• Subscription-Service-Tenders-Get-1.0.xsd
• Subscription-Service-Tenders-Update-1.0.xsd
• Subscription-Service-Update-1.0.xsd

Tax

• TaxDutyFee-Datatypes-1.0.xsd
• TaxDutyFee-DistributeRequest-1.0.xsd
• TaxDutyFee-InvoiceRequest-1.0.xsd
• TaxDutyFee-QuoteRequest-1.0.xsd
• TaxDutyFee-QuoteResponse-1.0.xsd