Get order items¶
Get order items for specific Invoice order
Prerequisites¶
Credentials as described in Authentication
An Organization identifier
An Order identifier
C#¶
var client = new CrayonApiClient("https://api.crayon.com/");
var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;
var result = await client.Orders.GetOrderItemsAsync(token, orderId, organizationId);
Request¶
Request Syntax:
Method |
Request URI |
|---|---|
GET |
https://api.crayon.com/api/v1/orders/{orderId}/items?organizationId=4205123 |
Request Parameters:
Name |
Type |
Required |
Description |
|---|---|---|---|
organizationId |
int |
Yes |
Identifier for an organization |
orderId |
long |
Yes |
Identifier for an order |
Request Headers:
The following HTTP request headers are supported
Header |
Type |
Description |
|---|---|---|
Authorization |
string |
Required. The authorization token in the form Bearer <token>. |
Accept |
string |
Specifies the response type, “application/json” |
Request Example:
GET $"https://api.crayon.com/api/v1/orders/{orderId}/items?organizationId=42051232"
Accept : application/json
Authorization : Bearer < Token >
Response¶
If successful, this method returns a collection of OrderItems in the response body.
{
"SkuValue": "CFQ7TTC0RP6W",
"LineDescription": "Office 365 E1 Plus",
"Price": 29.99,
"CurrencyCode": "USD",
"RowTotal": 29.99,
"Quantity": 1
}
Response success and error codes:
Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters.
Error Codes |
Description |
|---|---|
200 OK |
The request has succeeded. |
401 Unauthorized |
The request requires user authentication. If the request already included Authorization credentials, then the 401 (Unauthorized) status code means that authorization has been refused for those credentials. It is a non-retryable error condition. |