GET /sales/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- adjustmentReasonId integer(int32) | null
  
  Adjustment reason
- adminNotes string | null
  
  Admin notes
- billingAddressLineOne string | null
  
  Billing address line one
- billingAddressLineTwo string | null
  
  Billing address line two
- billingAddressMessage string | null
  
  Billing address message
- billingCity string | null
  
  Billing city
- billingCountry string | null
  
  Billing country
- billingFirstName string | null
  
  Billing first name
- billingFullName object | null | array | boolean | integer | number | string
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
  
  Billing full name
  
  Billing full name
  
  Billing full name
  
  Billing full name
  
  Billing full name
  
  Billing full name
- billingLastName string | null
  
  Billing last name
- billingName string | null
  
  Billing name
- billingState string | null
  
  Billing state
- billingZip string | null
  
  Billing zip
- cancelReason string | null
  
  Cancel reason
  
  Values are customer, fraud, inventory, declined, or other.
- cancellationStatus string Required
  
  Cancellation status
  
  Values are none, partial, or full. Default value is none.
- cancelled boolean Required
  
  Cancelled
  
  Default value is false.
- cancelledAt string(date-time) | null
  
  Cancelled at
- channelCancelledAt string(date-time) | null
  
  Channel cancelled at
- channelId integer(int32) Required
  
  Channel
- cityTaxLocation string | null
  
  City tax location
- cityTaxRate number(float) | null
  
  City tax rate
- cloneReason string | null
  
  Clone reason
  
  Values are exchange or new_sale.
- combinedTaxRate number(float) | null
  
  Combined tax rate
- countyTaxLocation string | null
  
  County tax location
- countyTaxRate number(float) | null
  
  County tax rate
- createdAt string(date-time)
  
  Created at
- currencyId integer(int32) | null
  
  Currency
- customerId integer(int32) | null
  
  Customer
- customerReference string | null
  
  Customer reference
- dateOrdered string(date-time) Required
  
  Date ordered
  
  Default value is {} (empty).
- discounts number Required
  
  Discounts
  
  Default value is 0.
- districtTaxRate number(float) | null
  
  District tax rate
- dropshipProblems object | null | array | boolean | integer | number | string
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
  
  Dropship problems
  
  Dropship problems
  
  Dropship problems
  
  Dropship problems
  
  Dropship problems
  
  Dropship problems
- exchangeRate number | null
  
  Exchange rate
- externalChannelSiteId string | null
  
  External channel site
- externalId string | null
  
  External
- finalized boolean Required
  
  Finalized
  
  Default value is true.
- id integer(int32)
  
  Id
- intercomMessageId string | null
  
  Intercom message
- internalNotes string | null
  
  Internal notes
- invalidBillingAddress string | null
  
  Invalid billing address
- invalidShippingAddress boolean | null Required
  
  Invalid shipping address
  
  Default value is false.
- inventoryStatus string Required
  
  Inventory status
  
  Values are notFulfilled, partiallyFulfilled, or fulfilled. Default value is notFulfilled.
- invoiceStatus string Required
  
  Invoice status
  
  Values are notInvoiced, partiallyInvoiced, or invoiced. Default value is notInvoiced.
- iso string | null
  
  Iso
- lastFulfillmentReference integer(int32) | null Required
  
  Last fulfillment reference
  
  Default value is 0.
- lastPurchaseReference integer(int32) | null Required
  
  Last purchase reference
  
  Default value is 0.
- lastSaleReturnReference integer(int32) | null Required
  
  Last sale return reference
  
  Default value is 0.
- locked boolean Required
  
  Locked
  
  Default value is false.
- muteError boolean | null Required
  
  Mute error
  
  Default value is false.
- notes string | null
  
  Notes
- paid number | null
  
  Paid
- paymentProviderIds array[string] | null Required
  
  Payment provider ids
  
  Default value is [] (empty).
- paymentStatus string Required
  
  Payment status
  
  Values are notPaid, partiallyPaid, or paid. Default value is notPaid.
- priceListId integer(int32) Required
  
  Price list
- quantity integer(int32) Required
  
  Quantity
  
  Default value is 0.
- receiverAddressLineOne string | null
  
  Receiver address line one
- receiverAddressLineTwo string | null
  
  Receiver address line two
- receiverCity string | null
  
  Receiver city
- receiverCountry string | null
  
  Receiver country
- receiverName string | null
  
  Receiver name
- receiverState string | null
  
  Receiver state
- receiverZip string | null
  
  Receiver zip
- reference string Required
  
  Reference
- resellerId integer(int32) | null
  
  Reseller
- resellerPayee string | null Required
  
  Reseller payee
  
  Values are reseller or customer. Default value is reseller.
- resellerStripeChargeId string | null
  
  Reseller stripe charge
- returnStatus string Required
  
  Return status
  
  Values are notReturned, partiallyReturned, or returned. Default value is notReturned.
- saleDiscountCodeId integer(int32) | null
  
  Sale discount code
- saleId integer(int32) | null
  
  Sale
- saleReturnProblems object | null | array | boolean | integer | number | string
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
  
  Sale return problems
  
  Sale return problems
  
  Sale return problems
  
  Sale return problems
  
  Sale return problems
  
  Sale return problems
- shippingAddressLineOne string | null
  
  Shipping address line one
- shippingAddressLineTwo string | null
  
  Shipping address line two
- shippingAddressMessage boolean | null Required
  
  Shipping address message
  
  Default value is false.
- shippingCity string | null
  
  Shipping city
- shippingCountry string | null
  
  Shipping country
- shippingFirstName string | null
  
  Shipping first name
- shippingFullName object | null | array | boolean | integer | number | string
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
  
  Shipping full name
  
  Shipping full name
  
  Shipping full name
  
  Shipping full name
  
  Shipping full name
  
  Shipping full name
- shippingLastName string | null
  
  Shipping last name
- shippingName string | null
  
  Shipping name
- shippingState string | null
  
  Shipping state
- shippingZip string | null
  
  Shipping zip
- shipstationId string | null
  
  Shipstation
- stateTaxLocation string | null
  
  State tax location
- stateTaxRate number(float) | null
  
  State tax rate
- status string Required
  
  Status
  
  Values are draft, pending, or finalized. Default value is pending.
- subtotal number Required
  
  Subtotal
  
  Default value is 0.
- tags array[string] | null
  
  Tags
- tax number Required
  
  Tax
  
  Default value is 0.
- taxCalculation string | null Required
  
  Tax calculation
  
  Values are default or custom. Default value is default.
- taxIncluded boolean Required
  
  Tax included
  
  Default value is false.
- taxShipping boolean | null Required
  
  Tax shipping
  
  Default value is true.
- total number Required
  
  Total
  
  Default value is 0.
- updatedAt string(date-time)
  
  Updated at
- userId integer(int32) | null
  
  User
- warehouseId integer(int32) Required
  
  Warehouse
- weight number(float) | null Required
  
  Weight
  
  Default value is 0.

curl \
 -X GET http://api.example.com/v1/sales/{id}.json \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "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": "2024-05-04T09:42:00+00:00",
  "channelCancelledAt": "2024-05-04T09:42:00+00:00",
  "channelId": 42,
  "cityTaxLocation": "string",
  "cityTaxRate": 42.0,
  "cloneReason": "exchange",
  "combinedTaxRate": 42.0,
  "countyTaxLocation": "string",
  "countyTaxRate": 42.0,
  "createdAt": "2024-05-04T09:42:00+00:00",
  "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": "2024-05-04T09:42:00+00:00",
  "userId": 42,
  "warehouseId": 42,
  "weight": 0
}

GET /sales/{id}.json

Path parameters

Responses

billingFullName object | null | array | boolean | integer | number | string

dropshipProblems object | null | array | boolean | integer | number | string

saleReturnProblems object | null | array | boolean | integer | number | string

shippingFullName object | null | array | boolean | integer | number | string