Body
Required
-
Adjustment reason
-
Admin notes
-
Billing address line one
-
Billing address line two
-
Billing address message
-
Billing city
-
Billing country
-
Billing first name
-
Billing last name
-
Billing name
-
Billing state
-
Billing zip
-
Cancel reason
Values are
customer
,fraud
,inventory
,declined
, orother
. -
Cancellation status
Values are
none
,partial
, orfull
. Default value isnone
. -
Cancelled
Default value is
false
. -
Cancelled at
-
Channel cancelled at
-
Channel
-
City tax location
-
City tax rate
-
Clone reason
Values are
exchange
ornew_sale
. -
Combined tax rate
-
County tax location
-
County tax rate
-
Created at
-
Currency
-
Customer
-
Customer reference
-
Date ordered
Default value is
{}
(empty). -
Discounts
Default value is
0
. -
District tax rate
-
Exchange rate
-
External channel site
-
External
-
Finalized
Default value is
true
. -
Id
-
Intercom message
-
Internal notes
-
Invalid billing address
-
Invalid shipping address
Default value is
false
. -
Inventory status
Values are
notFulfilled
,partiallyFulfilled
, orfulfilled
. Default value isnotFulfilled
. -
Invoice status
Values are
notInvoiced
,partiallyInvoiced
, orinvoiced
. Default value isnotInvoiced
. -
Iso
-
Last fulfillment reference
Default value is
0
. -
Last purchase reference
Default value is
0
. -
Last sale return reference
Default value is
0
. -
Locked
Default value is
false
. -
Mute error
Default value is
false
. -
Notes
-
Paid
-
Payment provider ids
Default value is
[]
(empty). -
Payment status
Values are
notPaid
,partiallyPaid
, orpaid
. Default value isnotPaid
. -
Price list
-
Quantity
Default value is
0
. -
Receiver address line one
-
Receiver address line two
-
Receiver city
-
Receiver country
-
Receiver name
-
Receiver state
-
Receiver zip
-
Reference
-
Reseller
-
Reseller payee
Values are
reseller
orcustomer
. Default value isreseller
. -
Reseller stripe charge
-
Return status
Values are
notReturned
,partiallyReturned
, orreturned
. Default value isnotReturned
. -
Sale discount code
-
Sale
-
Shipping address line one
-
Shipping address line two
-
Shipping address message
Default value is
false
. -
Shipping city
-
Shipping country
-
Shipping first name
-
Shipping last name
-
Shipping name
-
Shipping state
-
Shipping zip
-
Shipstation
-
State tax location
-
State tax rate
-
Status
Values are
draft
,pending
, orfinalized
. Default value ispending
. -
Subtotal
Default value is
0
. -
Tax
Default value is
0
. -
Tax calculation
Values are
default
orcustom
. Default value isdefault
. -
Tax included
Default value is
false
. -
Tax shipping
Default value is
true
. -
Total
Default value is
0
. -
Updated at
-
User
-
Warehouse
-
Weight
Default value is
0
.
curl \
--request POST 'http://api.example.com/v1/sales/{id}/clone.json' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"adjustmentReasonId":42,"adminNotes":"string","billingAddressLineOne":"string","billingAddressLineTwo":"string","billingAddressMessage":"string","billingCity":"string","billingCountry":"string","billingFirstName":"string","billingFullName":{},"billingLastName":"string","billingName":"string","billingState":"string","billingZip":"string","cancelReason":"customer","cancellationStatus":"none","cancelled":false,"cancelledAt":"2025-05-04T09:42:00Z","channelCancelledAt":"2025-05-04T09:42:00Z","channelId":42,"cityTaxLocation":"string","cityTaxRate":42.0,"cloneReason":"exchange","combinedTaxRate":42.0,"countyTaxLocation":"string","countyTaxRate":42.0,"createdAt":"2025-05-04T09:42:00Z","currencyId":42,"customerId":42,"customerReference":"string","dateOrdered":{},"discounts":0,"districtTaxRate":42.0,"dropshipProblems":{},"exchangeRate":42.0,"externalChannelSiteId":"string","externalId":"string","finalized":true,"id":42,"intercomMessageId":"string","internalNotes":"string","invalidBillingAddress":"string","invalidShippingAddress":false,"inventoryStatus":"notFulfilled","invoiceStatus":"notInvoiced","iso":"string","lastFulfillmentReference":0,"lastPurchaseReference":0,"lastSaleReturnReference":0,"locked":false,"muteError":false,"notes":"string","paid":42.0,"paymentProviderIds":[],"paymentStatus":"notPaid","priceListId":42,"quantity":0,"receiverAddressLineOne":"string","receiverAddressLineTwo":"string","receiverCity":"string","receiverCountry":"string","receiverName":"string","receiverState":"string","receiverZip":"string","reference":"string","resellerId":42,"resellerPayee":"reseller","resellerStripeChargeId":"string","returnStatus":"notReturned","saleDiscountCodeId":42,"saleId":42,"saleReturnProblems":{},"shippingAddressLineOne":"string","shippingAddressLineTwo":"string","shippingAddressMessage":false,"shippingCity":"string","shippingCountry":"string","shippingFirstName":"string","shippingFullName":{},"shippingLastName":"string","shippingName":"string","shippingState":"string","shippingZip":"string","shipstationId":"string","stateTaxLocation":"string","stateTaxRate":42.0,"status":"pending","subtotal":0,"tags":["string"],"tax":0,"taxCalculation":"default","taxIncluded":false,"taxShipping":true,"total":0,"updatedAt":"2025-05-04T09:42:00Z","userId":42,"warehouseId":42,"weight":0}'
{
"adjustmentReasonId": 42,
"adminNotes": "string",
"billingAddressLineOne": "string",
"billingAddressLineTwo": "string",
"billingAddressMessage": "string",
"billingCity": "string",
"billingCountry": "string",
"billingFirstName": "string",
"billingFullName": {},
"billingLastName": "string",
"billingName": "string",
"billingState": "string",
"billingZip": "string",
"cancelReason": "customer",
"cancellationStatus": "none",
"cancelled": false,
"cancelledAt": "2025-05-04T09:42:00Z",
"channelCancelledAt": "2025-05-04T09:42:00Z",
"channelId": 42,
"cityTaxLocation": "string",
"cityTaxRate": 42.0,
"cloneReason": "exchange",
"combinedTaxRate": 42.0,
"countyTaxLocation": "string",
"countyTaxRate": 42.0,
"createdAt": "2025-05-04T09:42:00Z",
"currencyId": 42,
"customerId": 42,
"customerReference": "string",
"dateOrdered": {},
"discounts": 0,
"districtTaxRate": 42.0,
"dropshipProblems": {},
"exchangeRate": 42.0,
"externalChannelSiteId": "string",
"externalId": "string",
"finalized": true,
"id": 42,
"intercomMessageId": "string",
"internalNotes": "string",
"invalidBillingAddress": "string",
"invalidShippingAddress": false,
"inventoryStatus": "notFulfilled",
"invoiceStatus": "notInvoiced",
"iso": "string",
"lastFulfillmentReference": 0,
"lastPurchaseReference": 0,
"lastSaleReturnReference": 0,
"locked": false,
"muteError": false,
"notes": "string",
"paid": 42.0,
"paymentProviderIds": [],
"paymentStatus": "notPaid",
"priceListId": 42,
"quantity": 0,
"receiverAddressLineOne": "string",
"receiverAddressLineTwo": "string",
"receiverCity": "string",
"receiverCountry": "string",
"receiverName": "string",
"receiverState": "string",
"receiverZip": "string",
"reference": "string",
"resellerId": 42,
"resellerPayee": "reseller",
"resellerStripeChargeId": "string",
"returnStatus": "notReturned",
"saleDiscountCodeId": 42,
"saleId": 42,
"saleReturnProblems": {},
"shippingAddressLineOne": "string",
"shippingAddressLineTwo": "string",
"shippingAddressMessage": false,
"shippingCity": "string",
"shippingCountry": "string",
"shippingFirstName": "string",
"shippingFullName": {},
"shippingLastName": "string",
"shippingName": "string",
"shippingState": "string",
"shippingZip": "string",
"shipstationId": "string",
"stateTaxLocation": "string",
"stateTaxRate": 42.0,
"status": "pending",
"subtotal": 0,
"tags": [
"string"
],
"tax": 0,
"taxCalculation": "default",
"taxIncluded": false,
"taxShipping": true,
"total": 0,
"updatedAt": "2025-05-04T09:42:00Z",
"userId": 42,
"warehouseId": 42,
"weight": 0
}
{
"adjustmentReasonId": 42,
"adminNotes": "string",
"billingAddressLineOne": "string",
"billingAddressLineTwo": "string",
"billingAddressMessage": "string",
"billingCity": "string",
"billingCountry": "string",
"billingFirstName": "string",
"billingFullName": {},
"billingLastName": "string",
"billingName": "string",
"billingState": "string",
"billingZip": "string",
"cancelReason": "customer",
"cancellationStatus": "none",
"cancelled": false,
"cancelledAt": "2025-05-04T09:42:00Z",
"channelCancelledAt": "2025-05-04T09:42:00Z",
"channelId": 42,
"cityTaxLocation": "string",
"cityTaxRate": 42.0,
"cloneReason": "exchange",
"combinedTaxRate": 42.0,
"countyTaxLocation": "string",
"countyTaxRate": 42.0,
"createdAt": "2025-05-04T09:42:00Z",
"currencyId": 42,
"customerId": 42,
"customerReference": "string",
"dateOrdered": {},
"discounts": 0,
"districtTaxRate": 42.0,
"dropshipProblems": {},
"exchangeRate": 42.0,
"externalChannelSiteId": "string",
"externalId": "string",
"finalized": true,
"id": 42,
"intercomMessageId": "string",
"internalNotes": "string",
"invalidBillingAddress": "string",
"invalidShippingAddress": false,
"inventoryStatus": "notFulfilled",
"invoiceStatus": "notInvoiced",
"iso": "string",
"lastFulfillmentReference": 0,
"lastPurchaseReference": 0,
"lastSaleReturnReference": 0,
"locked": false,
"muteError": false,
"notes": "string",
"paid": 42.0,
"paymentProviderIds": [],
"paymentStatus": "notPaid",
"priceListId": 42,
"quantity": 0,
"receiverAddressLineOne": "string",
"receiverAddressLineTwo": "string",
"receiverCity": "string",
"receiverCountry": "string",
"receiverName": "string",
"receiverState": "string",
"receiverZip": "string",
"reference": "string",
"resellerId": 42,
"resellerPayee": "reseller",
"resellerStripeChargeId": "string",
"returnStatus": "notReturned",
"saleDiscountCodeId": 42,
"saleId": 42,
"saleReturnProblems": {},
"shippingAddressLineOne": "string",
"shippingAddressLineTwo": "string",
"shippingAddressMessage": false,
"shippingCity": "string",
"shippingCountry": "string",
"shippingFirstName": "string",
"shippingFullName": {},
"shippingLastName": "string",
"shippingName": "string",
"shippingState": "string",
"shippingZip": "string",
"shipstationId": "string",
"stateTaxLocation": "string",
"stateTaxRate": 42.0,
"status": "pending",
"subtotal": 0,
"tags": [
"string"
],
"tax": 0,
"taxCalculation": "default",
"taxIncluded": false,
"taxShipping": true,
"total": 0,
"updatedAt": "2025-05-04T09:42:00Z",
"userId": 42,
"warehouseId": 42,
"weight": 0
}