GET /purchases/{id}.json

GET /purchases/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

Responses

GET /purchases/{id}.json
curl \
 -X GET http://api.example.com/v1/purchases/{id}.json \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "adjustmentReasonId": 42,
  "adminNotes": "string",
  "approved": true,
  "billingAddressLineOne": "string",
  "billingAddressLineTwo": "string",
  "billingAddressMessage": "string",
  "billingCity": "string",
  "billingCountry": "string",
  "billingFirstName": "string",
  "billingFullName": {},
  "billingLastName": "string",
  "billingName": "string",
  "billingState": "string",
  "billingZip": "string",
  "cancellationStatus": "none",
  "cancelled": false,
  "cancelledAt": "2024-05-04T09:42:00+00:00",
  "cityTaxLocation": "string",
  "cityTaxRate": 42.0,
  "combinedTaxRate": 42.0,
  "countyTaxLocation": "string",
  "countyTaxRate": 42.0,
  "createdAt": "2024-05-04T09:42:00+00:00",
  "customerReference": "string",
  "dateOrdered": {},
  "deliveryExpectedAt": "2024-05-04T09:42:00+00:00",
  "discounts": 0,
  "districtTaxRate": 42.0,
  "dropshipNotes": "string",
  "dropshipProviderAddressId": 42,
  "dropshipProviderId": 42,
  "files": {},
  "finalized": true,
  "id": 42,
  "intercomMessageId": "string",
  "internalReference": "string",
  "invalidBillingAddress": "string",
  "invalidShippingAddress": false,
  "inventoryStatus": "notReceived",
  "invoiceProblem": {},
  "invoiceStatus": "notInvoiced",
  "isDropship": true,
  "labelProblem": {},
  "lastDropshipmentReference": 0,
  "lastGoodsReceiptReference": 0,
  "lastPurchaseInvoiceReference": 0,
  "locked": false,
  "muteError": false,
  "notes": "string",
  "orderProblem": {},
  "orderSplitting": "group",
  "orderSplittingKey": "string",
  "pauseProblems": {},
  "paymentExpectedAt": "2024-05-04T09:42:00+00:00",
  "paymentStatus": "notPaid",
  "priceListId": 42,
  "purchaseId": 42,
  "purchaseImportExternalId": "string",
  "purchaseStatusId": 42,
  "purchaseType": "replenishment",
  "quantity": 0,
  "receiverAddressLineOne": "string",
  "receiverAddressLineTwo": "string",
  "receiverCity": "string",
  "receiverCountry": "string",
  "receiverName": "string",
  "receiverState": "string",
  "receiverZip": "string",
  "reference": "string",
  "reminderLastSent": "2024-05-04T09:42:00+00:00",
  "reminderSent": false,
  "returnLabelProblem": {},
  "returnStatus": "notReturned",
  "saleId": 42,
  "sendSource": "manual",
  "shipmentRouting": "customer",
  "shippingAddressLineOne": "string",
  "shippingAddressLineTwo": "string",
  "shippingAddressMessage": false,
  "shippingCity": "string",
  "shippingCountry": "string",
  "shippingExpectedAt": "2024-05-04T09:42:00+00:00",
  "shippingFirstName": "string",
  "shippingFullName": {},
  "shippingLastName": "string",
  "shippingName": "string",
  "shippingRateError": "value",
  "shippingState": "string",
  "shippingZip": "string",
  "splitTag": "string",
  "stateTaxLocation": "string",
  "stateTaxRate": 42.0,
  "subtotal": 0,
  "tags": [
    "string"
  ],
  "tax": 0,
  "taxCalculation": "default",
  "taxIncluded": false,
  "taxShipping": true,
  "total": 0,
  "updatedAt": "2024-05-04T09:42:00+00:00",
  "userId": 42,
  "vendorEndpointFormat": "json",
  "vendorEndpointHeaders": {},
  "vendorEndpointResponse": "string",
  "vendorId": 42,
  "vendorReceivedId": "string",
  "vendorReceivedReference": "string",
  "vendorReceivedStatus": "notSent",
  "vendorReceivedStatusReason": "sent",
  "vendorReference": "string",
  "warehouseId": 42,
  "weight": 0
}