Get shipment item by id

GET 
https://api.helice.cloud/v2/orders/shipments/items/:id

Get shipment item by id

Request

Path Parameters

id uuidrequired

Shipment item id

Responses

200

Get shipment item by id

application/json

Schema

Schema

iduuidrequired
Unique identifier
Example: 0190fdc1-0153-70b8-8ad3-9d7204270060
createdAtdate-timerequired
Creation date
Example: 2023-05-23T18:25:43.511Z
lastModifiedAtdate-timerequired
Last modified date
Example: 2023-05-23T18:25:43.511Z
namestringnullable
Shipment item name
Example: My Name
skustringnullable
Product SKU
Example: sku-1242
quantityintegernullable
Shipment item quantity
Example: 42
shipmentIduuidrequired
Shipment unique identifier
Example: 0190fdc1-0153-70b8-8ad3-9d7204270060
orderItemIduuidrequired
Shipment unique identifier
Example: 0190fdc1-0153-70b8-8ad3-9d7204270060

Example (auto)

{
  "id": "0190fdc1-0153-70b8-8ad3-9d7204270060",
  "createdAt": "2023-05-23T18:25:43.511Z",
  "lastModifiedAt": "2023-05-23T18:25:43.511Z",
  "name": "My Name",
  "sku": "sku-1242",
  "quantity": 42,
  "shipmentId": "0190fdc1-0153-70b8-8ad3-9d7204270060",
  "orderItemId": "0190fdc1-0153-70b8-8ad3-9d7204270060"
}

400

Bad request

403

Forbidden.

404

Shipment item not found

500

Get shipment item error

Authorization: OAuth2

name: OAuth2type: oauth2bearerFormat: tokenscheme: bearerdescription: OAuth2 Authorizationin: headerflows: {
  "clientCredentials": {
    "tokenUrl": "https://api.helice.cloud/oauth2/token/",
    "scopes": {}
  }
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.helice.cloud/v2/orders/shipments/items/:id");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <OAuth2>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.helice.cloud

Auth

Bearer Token

Parameters

id — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!