Overview
In order to retrieve metadata of a purchase order, you must:
- Be authenticated user
Information on how you can authenticate: Authentication
As soon as you do authentication and receive a valid token, it needs to be passed on the call for receiving a single purchase order.
- Have valid ID of an existing purchase order.
Endpoint
Example for such endpoint for TT server is https://tt.api.sellercloud.com/rest/api/PurchaseOrders/{id}
Request

- Method Type: HttpGet
- Authorization: Use Bearer Token + token received from token authentication
- Header info: Content-Type: application/json
- Parameters: ID of the purchase order
Parameter | Data Type | Description | Is Required |
id | integer | ID of existing purchase order | true |
Example: https://tt.api.sellercloud.com/rest/api/PurchaseOrders/11
Response
- If user is authenticated and provides a valid ID of an order, then response will be Status Code 200 => OK and purchase order metadata in JSON format
- If user is not authenticated, then response will be Status Code 401 => Not Valid Token
- On server response => Status Code 500 => Internal Server Error
Response Body Format
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
{ "Purchase": { "POId": 0, "CompanyId": 0, "VendorId": 0, "OrderedOn": "2021-01-06T12:27:59.183Z", "RequestedOn": "2021-01-06T12:27:59.183Z", "OrderType": "Default", "OrderTypeEnable": true, "POType": "PurchaseOrder", "Description": "string", "DefaultWarehouseID": 0, "ExpectedDelivery": "2021-01-06T12:27:59.183Z", "RequireExpectedDeliveryDate": true, "CancelByDate": "2021-01-06T12:27:59.183Z", "CreditMemoID": 0, "CurrencyCode": "USD", "CurrencyRateToUSD": 0, "CurrencyRateFromUSD": 0, "ReceivingStatus": "None", "RelatedFbaId": 0, "Instructions": "string", "IsModified": true }, "VendorAndInvoice": { "PaymentTermID": 0, "InvoiceNumber": "string", "InvoiceDate": "2021-01-06T12:27:59.183Z", "VendorInvoice": { "FileName": "string", "NewFileToken": "string", "DeleteFile": true }, "Memo": "string", "InvoiceLineCount": "string", "InvoiceLink": "string", "EnableVendorInvoicesWorkflow": true, "EnableMultipleinvoicesforpurchaseorders": true, "PaymentStatus": "NoPayment", "Balance": 0, "TotalPaid": 0, "TotalRefunded": 0, "OverRecived": 0, "IsModified": true }, "Changes": { "CreatedBy": "string", "CreatedByEmployeeId": 0, "CreatedOn": "2021-01-06T12:27:59.183Z", "UpdatedBy": "string", "UpdatedByEmployeeId": 0, "UpdatedOn": "2021-01-06T12:27:59.183Z", "ApprovedBy": "string", "ApprovedByEmployeeId": 0, "ApprovedOn": "2021-01-06T12:27:59.183Z", "ReceivedBy": "string", "ReceivedByEmployeeId": 0, "ReceivedOn": "2021-01-06T12:27:59.183Z" }, "RelatedItems": [ { "ID": 0, "RecordType": "string", "Url": "string" } ], "TotalInfo": { "DiscountTotal": 0, "DiscountTotalFixed": true, "MultiDiscountTotal": 0, "EnableMultiDiscountForPurchaseOrder": true, "SubTotal": 0, "FreeShipping": true, "ShippingTotal": 0, "EnableShippingTotal": true, "DropShipFeeTotal": 0, "ShippingTotalThirdParty": 0, "EnableShippingTotalThirdParty": true, "CustomsTotal": 0, "TaxTotal": 0, "OtherTotal": 0, "SmallOrderFee": 0, "CreditCardFee": 0, "GrandTotal": 0, "UnreceivedTotal": 0, "EnableFreeShippingForPurchaseOrders": true, "EditFreeShippingForPurchaseOrders": true, "EditShippingTotal": true, "EnableOrderDropShipFee": true, "PurchaseOrdersEnableCustomsTotalField": true, "SmallOrderFeeVisible": true, "EnableCreditCardFeeOnPurchaseOrders": true, "HidePrices": true, "DoNotIncludeThirdPartyShippingInPOGrandTotal": true, "UseFixedDiscountTotal": true, "UseDiscountTotal": true, "EnableVendorInvoicesWorkflow": true, "IsFullyRecivedandshipped": true, "IsModified": true }, "CustomColumns": [ { "ID": 0, "DataType": "String", "DataLength": 0, "IsDropDownColumn": true, "IsDropDownCustomTextAllowed": true, "ClientID": 0, "NewValue": {}, "DataSourceContainer": [ { "Key": "string", "Value": "string", "Additional": {} } ], "ColumnName": "string", "DisplayName": "string", "Value": {} } ], "Metadata": { "PurchaseOrderCurrencyDigitsCount": 0, "EnableCaseQty": true, "EnabledMultipleDiscounts": true, "FixedTotalDiscount": true, "EnablePerCaseQtyModeSetting": true, "EnableVendorInvoicesWorkflow": true, "AllowToIgnoreInventoryInPurchaseOrder": true, "EnableShippingContainers": true, "EnablePOFBAAllocationQty": true, "EnableNotesForPurchaseItems": true, "EnableLocalNotesForPurchaseItems": true, "EnableCurrencySymbolForPO": true, "ShowASINAndUPCInPoItems": true, "ShowQtyOnHandInPoItems": true, "EnableExpectedDeliveryForPurchaseItems": true }, "Statuses": { "Status": "Saved", "IsApproved": true, "Priority": "Normal", "ShippingStatus": "None", "ReceivingStatus": "None", "PaymentStatus": "NoPayment", "InvoicedStatus": "string", "InventoryCount": "string", "EmailSent": "string" }, "ShowProductImageForItems": true, "EnablePoPrSellQuantity": true, "NotesCount": 0, "IsModified": true } |