GET /sales/{id}.json
GET
/sales/{id}.json
Path parameters
-
id integer(int64) Required
Numeric ID of the instance
Minimum value is
1.
GET /sales/{id}.json
curl \
-X GET http://api.example.com/v1/sales/{id}.json
Response example (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": "2023-05-04T09:42:00+00:00",
"channelCancelledAt": "2023-05-04T09:42:00+00:00",
"channelId": 42,
"cityTaxLocation": "string",
"cityTaxRate": 42.0,
"cloneReason": "exchange",
"combinedTaxRate": 42.0,
"countyTaxLocation": "string",
"countyTaxRate": 42.0,
"createdAt": "2023-05-04T09:42:00+00:00",
"customerId": 42,
"customerReference": "string",
"dateOrdered": {},
"discounts": 0,
"districtTaxRate": 42.0,
"dropshipProblems": {},
"externalId": "string",
"finalized": true,
"id": 42,
"intercomMessageId": "string",
"internalNotes": "string",
"invalidBillingAddress": "string",
"invalidShippingAddress": false,
"inventoryStatus": "notFulfilled",
"invoiceStatus": "notInvoiced",
"lastFulfillmentReference": 0,
"lastPurchaseReference": 0,
"lastSaleReturnReference": 0,
"locked": false,
"muteError": false,
"notes": "string",
"paid": 42.0,
"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,
"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": "2023-05-04T09:42:00+00:00",
"userId": 42,
"warehouseId": 42,
"weight": 0
}