v1

latestOpenAPI 3.1.02026-07-241660500.9 KB
Get Order Receipt

get/v3/orderreceipt
Query parameters

receiptNumberstring required
accessCodestring required
Response

200
orderHistoryobject[]
paymentsobject[]
paymentSignaturesobject[]
barCodestring
Example response

{
  "order": {
    "id": 351154,
    "merchantId": 516167953,
    "created": "2022-03-16T13:51:56.1Z",
    "modified": "2022-03-16T13:52:32.34Z",
    "sourceType": "POS",
    "orderedDate": "2022-03-20T04:00:00Z",
    "shippedDate": "2022-03-30T04:00:00Z",
    "reference": "O3J2GJA1B8IC",
    "accessCode": "ZQJWZQ",
    "orderStatus": "Active",
    "invoiceStatus": "Draft",
    "paymentStatus": "Unpaid",
    "packingStatus": "Unpacked",
    "fulfillmentStatus": "Unfulfilled",
    "returnStatus": "None",
    "subtotalAmount": "11.11",
    "discountAmount": "0",
    "taxAmount": "0",
    "totalAmount": "11.11",
    "balance": "11.11",
    "invoicedAmount": "0",
    "paidAmount": "0",
    "lineItemCount": 1,
    "saleQuantity": 1,
    "netQuantity": 1,
    "customerName": "API Test",
    "contactEmail": "api@test.com",
    "lineItems": [
      {
        "quantityReturned": "0",
        "quantityInvoiced": "0",
        "created": "2022-03-16T13:51:56.523Z",
        "modified": "2022-03-16T13:52:33.073Z",
        "id": 661345,
        "name": "t",
        "price": "11.11",
        "discountRate": "0",
        "discountAmount": "0",
        "priceDiscountAmount": "0",
        "taxRate": "0",
        "taxAmount": "0",
        "quantity": "1",
        "amount": "11.11"
      }
    ],
    "orderNumber": 1063,
    "barCode": "iVBORw0KGgoAAAANSUhEUgAAAKoAAAAgCAYAAACCXeM8AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAbDSURBVHhe7ZJBiixZDAP7/pfuQQkBkcI2ufwDHVCkFPLb1c/vH3/8D3j+qD8/P8+P3Nj1zlv8lkP7a3OmQ7vpjmzvPWy937iDd3PdBvbJkY39tNl7tw/dw9a/3PVtO3e4HN5fcnjSdGheD2rnLX7Lof21OdOh3XRHtvcett5v3MG7uW4D++TIxn7a7L3bh+5h61/u+radO1wO7y85PGk6NK8HtfMWv+XQ/tqc6dBuuiPbew9b7zfu4N1ct4F9cmRjP2323u1D97D1L3d9284dLof3lxyeNB2a14PaeYvfcmh/bc50aDfdke29h633G3fwbq7bwD45srGfNnvv9qF72PqXu75t5w6Xw/tLDk+aDs3rQe28xW85tL82Zzq0m+7I9t7D1vuNO3g3121gnxzZ2E+bvXf70D1s/ctd37Zzh8vh/SWHJ02H5vWgdt7itxzaX5szHdpNd2R772Hr/cYdvJvrNrBPjmzsp83eu33oHrb+5a5v27nD5fD+ksOTpkPzelA7b/FbDu2vzZkO7aY7sr33sPV+4w7ezXUb2CdHNvbTZu/dPnQPW/9y17ft3OFyeH/J4UnToXk9qJ23+C2H9tfmTId20x3Z3nvYer9xB+/mug3skyMb+2mz924fuoetf7nr23bucDm8v+TwpOnQvB7Uzlv8lkP7a3OmQ7vpjmzvPWy937iDd3PdBvbJkY39tNl7tw/dw9a/3PVtO3e4HN5fcnjSdGheD2rnLX7Lof21OdOh3XRHtvcett5v3MG7uW4D++TIxn7a7L3bh+5h61/u+radO1wO7y85PGk6NK8HtfMWv+XQ/tqc6dBuuiPbew9b7zfu4N1ct4F9cmRjP2323u1D97D1L3d9284dLof3lxyeNB2a14PaeYvfcmh/bc50aDfdke29h633G3fwbq7bwD45srGfNnvv9qF72PqXu75t5w6Xw/tLDk+aDs3rQe28xW85tL82Zzq0m+7I9t7D1vuNO3g3121gnxzZ2E+bvXf70D1s/ctd37Zzh8vh/SWHJ02H5vWgdt7itxzaX5szHdpNd2R772Hr/cYdvJvrNrBPjmzsp83eu33oHrb+5a5v27nD5fD+ksOTpkPzelA7b/FbDu2vzZkO7aY7sr33sPV+4w7ezXUb2CdHNvbTZu/dPnQPW/9y17ft3OFyeH/J4UnToXk9qJ23+C2H9tfmTId20x3Z3nvYer9xB+/mug3skyMb+2mz924fuoetf7nr23bucDm8v+TwpOnQvB7Uzlv8lkP7a3OmQ7vpjmzvPWy937iDd3PdBvbJkY39tNl7tw/dw9a/3PVtO3e4HN5fcnjSdGheD2rnLX7Lof21OdOh3XRHtvcett5v3MG7uW4D++TIxn7a7L3bh+5h61/u+radO1wO7y85PGk6NK8HtfMWv+XQ/tqc6dBuuiPbew9b7zfu4N1ct4F9cmRjP2323u1D97D1L3d9284dLof3lxyeNB2a14PaeYvfcmh/bc50aDfdke29h633G3fwbq7bwD45srGfNnvv9qF72PqXu75t5w6Xw/tLDk+aDs3rQe28xW85tL82Zzq0m+7I9t7D1vuNO3g3121gnxzZ2E+bvXf70D1s/ctd37Zzh8vh/SWHJ02H5vWgdt7itxzaX5szHdpNd2R772Hr/cYdvJvrNrBPjmzsp83eu33oHrb+5a5v27nD5fD+ksOTpkPzelA7b/FbDu2vzZkO7aY7sr33sPV+4w7ezXUb2CdHNvbTZu/dPnQPW/9y17ft3OFyeH/J4UnToXk9qJ23+C2H9tfmTId20x3Z3nvYer9xB+/mug3skyMb+2mz924fuoetf7nr23bucDm8v+TwpOnQvB7Uzlv8lkP7a3OmQ7vpjmzvPWy937iDd3PdBvbJkY39tNl7tw/dw9a/3PVtO3e4HN5fcnjSdGheD2rnLX7Lof21OdOh3XRHtvcett5v3MG7uW4D++TIxn7a7L3bh+5h61/u+radO1wO7y85PGk6NK8HtfMWv+XQ/tqc6dBuuiPbew9b7zfu4N1ct4F9cmRjP2323u1D97D1L3d9284dLof3lxyeNB2a14PaeYvfcmh/bc50aDfdke29h633G3fwbq7bwD45srGfNnvv9qF72PqXu75t5w6Xw/tLDk+aDs3rQe28xW85tL82Zzq0m+7I9t7D1vuNO3g3121gnxzZ2E+bvXf70D1s/ctd37Zzh8vh/SWHJ02H5vWgdt7itxzaX5szHdpNd2R772Hr/cYdvJvrNrBPjmzsp83eu33oHrb+5a5v27nD5fD+ksP71R9//JP8/v4H0/uqaVHYMCIAAAAASUVORK5CYII="
  },
  "receiptOptions": {
    "showPhone": true,
    "showWebsiteUrl": true,
    "returnPolicy": "Not provided",
    "name": "Mayael the Anima",
    "phone": "8009355961",
    "email": "apihelp@pps.io",
    "websiteUrl": "www.sandbox.com",
    "address": {
      "address1": "2001 Westside Parkway",
      "city": "Alpharetta",
      "state": "GA",
      "zip": "30076"
    },
    "receiptType": "Classic",
    "xmid": "8739123236300143"
  },
  "lossPrevention": {
    "emsPaymentAmountThreshold": "500",
    "declineEmsScoreThreshold": 300
  },
  "barCode": "iVBORw0KGgoAAAANSUhEUgAAAKoAAAAgCAYAAACCXeM8AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAbDSURBVHhe7ZJBiixZDAP7/pfuQQkBkcI2ufwDHVCkFPLb1c/vH3/8D3j+qD8/P8+P3Nj1zlv8lkP7a3OmQ7vpjmzvPWy937iDd3PdBvbJkY39tNl7tw/dw9a/3PVtO3e4HN5fcnjSdGheD2rnLX7Lof21OdOh3XRHtvcett5v3MG7uW4D++TIxn7a7L3bh+5h61/u+radO1wO7y85PGk6NK8HtfMWv+XQ/tqc6dBuuiPbew9b7zfu4N1ct4F9cmRjP2323u1D97D1L3d9284dLof3lxyeNB2a14PaeYvfcmh/bc50aDfdke29h633G3fwbq7bwD45srGfNnvv9qF72PqXu75t5w6Xw/tLDk+aDs3rQe28xW85tL82Zzq0m+7I9t7D1vuNO3g3121gnxzZ2E+bvXf70D1s/ctd37Zzh8vh/SWHJ02H5vWgdt7itxzaX5szHdpNd2R772Hr/cYdvJvrNrBPjmzsp83eu33oHrb+5a5v27nD5fD+ksOTpkPzelA7b/FbDu2vzZkO7aY7sr33sPV+4w7ezXUb2CdHNvbTZu/dPnQPW/9y17ft3OFyeH/J4UnToXk9qJ23+C2H9tfmTId20x3Z3nvYer9xB+/mug3skyMb+2mz924fuoetf7nr23bucDm8v+TwpOnQvB7Uzlv8lkP7a3OmQ7vpjmzvPWy937iDd3PdBvbJkY39tNl7tw/dw9a/3PVtO3e4HN5fcnjSdGheD2rnLX7Lof21OdOh3XRHtvcett5v3MG7uW4D++TIxn7a7L3bh+5h61/u+radO1wO7y85PGk6NK8HtfMWv+XQ/tqc6dBuuiPbew9b7zfu4N1ct4F9cmRjP2323u1D97D1L3d9284dLof3lxyeNB2a14PaeYvfcmh/bc50aDfdke29h633G3fwbq7bwD45srGfNnvv9qF72PqXu75t5w6Xw/tLDk+aDs3rQe28xW85tL82Zzq0m+7I9t7D1vuNO3g3121gnxzZ2E+bvXf70D1s/ctd37Zzh8vh/SWHJ02H5vWgdt7itxzaX5szHdpNd2R772Hr/cYdvJvrNrBPjmzsp83eu33oHrb+5a5v27nD5fD+ksOTpkPzelA7b/FbDu2vzZkO7aY7sr33sPV+4w7ezXUb2CdHNvbTZu/dPnQPW/9y17ft3OFyeH/J4UnToXk9qJ23+C2H9tfmTId20x3Z3nvYer9xB+/mug3skyMb+2mz924fuoetf7nr23bucDm8v+TwpOnQvB7Uzlv8lkP7a3OmQ7vpjmzvPWy937iDd3PdBvbJkY39tNl7tw/dw9a/3PVtO3e4HN5fcnjSdGheD2rnLX7Lof21OdOh3XRHtvcett5v3MG7uW4D++TIxn7a7L3bh+5h61/u+radO1wO7y85PGk6NK8HtfMWv+XQ/tqc6dBuuiPbew9b7zfu4N1ct4F9cmRjP2323u1D97D1L3d9284dLof3lxyeNB2a14PaeYvfcmh/bc50aDfdke29h633G3fwbq7bwD45srGfNnvv9qF72PqXu75t5w6Xw/tLDk+aDs3rQe28xW85tL82Zzq0m+7I9t7D1vuNO3g3121gnxzZ2E+bvXf70D1s/ctd37Zzh8vh/SWHJ02H5vWgdt7itxzaX5szHdpNd2R772Hr/cYdvJvrNrBPjmzsp83eu33oHrb+5a5v27nD5fD+ksOTpkPzelA7b/FbDu2vzZkO7aY7sr33sPV+4w7ezXUb2CdHNvbTZu/dPnQPW/9y17ft3OFyeH/J4UnToXk9qJ23+C2H9tfmTId20x3Z3nvYer9xB+/mug3skyMb+2mz924fuoetf7nr23bucDm8v+TwpOnQvB7Uzlv8lkP7a3OmQ7vpjmzvPWy937iDd3PdBvbJkY39tNl7tw/dw9a/3PVtO3e4HN5fcnjSdGheD2rnLX7Lof21OdOh3XRHtvcett5v3MG7uW4D++TIxn7a7L3bh+5h61/u+radO1wO7y85PGk6NK8HtfMWv+XQ/tqc6dBuuiPbew9b7zfu4N1ct4F9cmRjP2323u1D97D1L3d9284dLof3lxyeNB2a14PaeYvfcmh/bc50aDfdke29h633G3fwbq7bwD45srGfNnvv9qF72PqXu75t5w6Xw/tLDk+aDs3rQe28xW85tL82Zzq0m+7I9t7D1vuNO3g3121gnxzZ2E+bvXf70D1s/ctd37Zzh8vh/SWHJ02H5vWgdt7itxzaX5szHdpNd2R772Hr/cYdvJvrNrBPjmzsp83eu33oHrb+5a5v27nD5fD+ksP71R9//JP8/v4H0/uqaVHYMCIAAAAASUVORK5CYII="
}