GET api/WebApiOdata/GetShippingLabels?providerID={providerID}&isPicking={isPicking}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| providerID | integer |
Required |
|
| isPicking | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Collection of ShippingLabelsViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ShippingLabelId | integer |
None. |
|
| ReferenceCode | string |
None. |
|
| ShipFrom | string |
None. |
|
| ShipTo | string |
None. |
|
| ShipToType | byte |
None. |
|
| ShipDateDisplay | string |
None. |
|
| CreatedDate | string |
None. |
|
| PickedDate | string |
None. |
|
| PickedBy | string |
None. |
|
| ShippedBy | string |
None. |
|
| CreatedBy | string |
None. |
|
| TotalPackages | integer |
None. |
|
| TotalItems | integer |
None. |
|
| OrderNumbers | string |
None. |
|
| PackageNumbers | string |
None. |
|
| ShipmentMethod | string |
None. |
|
| ShipmentStatus | byte |
None. |
|
| ShipmentStatusDisplay | string |
None. |
|
| ShipToTypeDisplay | string |
None. |
Response Formats
application/json, text/json, text/html
Sample:
[
{
"ShippingLabelId": 1,
"ReferenceCode": "sample string 2",
"ShipFrom": "sample string 3",
"ShipTo": "sample string 4",
"ShipToType": 64,
"ShipDateDisplay": "sample string 6",
"CreatedDate": "sample string 7",
"PickedDate": "sample string 8",
"PickedBy": "sample string 9",
"ShippedBy": "sample string 10",
"CreatedBy": "sample string 11",
"TotalPackages": 12,
"TotalItems": 13,
"OrderNumbers": "sample string 14",
"PackageNumbers": "sample string 15",
"ShipmentMethod": "sample string 16",
"ShipmentStatus": 64,
"ShipmentStatusDisplay": "N.A.",
"ShipToTypeDisplay": "N.A."
},
{
"ShippingLabelId": 1,
"ReferenceCode": "sample string 2",
"ShipFrom": "sample string 3",
"ShipTo": "sample string 4",
"ShipToType": 64,
"ShipDateDisplay": "sample string 6",
"CreatedDate": "sample string 7",
"PickedDate": "sample string 8",
"PickedBy": "sample string 9",
"ShippedBy": "sample string 10",
"CreatedBy": "sample string 11",
"TotalPackages": 12,
"TotalItems": 13,
"OrderNumbers": "sample string 14",
"PackageNumbers": "sample string 15",
"ShipmentMethod": "sample string 16",
"ShipmentStatus": 64,
"ShipmentStatusDisplay": "N.A.",
"ShipToTypeDisplay": "N.A."
}
]
application/xml, text/xml
Sample:
<ArrayOfShippingLabelsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SellersCommerce.ViewModels.Orders">
<ShippingLabelsViewModel>
<CreatedBy>sample string 11</CreatedBy>
<CreatedDate>sample string 7</CreatedDate>
<OrderNumbers>sample string 14</OrderNumbers>
<PackageNumbers>sample string 15</PackageNumbers>
<PickedBy>sample string 9</PickedBy>
<PickedDate>sample string 8</PickedDate>
<ReferenceCode>sample string 2</ReferenceCode>
<ShipDateDisplay>sample string 6</ShipDateDisplay>
<ShipFrom>sample string 3</ShipFrom>
<ShipTo>sample string 4</ShipTo>
<ShipToType>64</ShipToType>
<ShipmentMethod>sample string 16</ShipmentMethod>
<ShipmentStatus>64</ShipmentStatus>
<ShippedBy>sample string 10</ShippedBy>
<ShippingLabelId>1</ShippingLabelId>
<TotalItems>13</TotalItems>
<TotalPackages>12</TotalPackages>
</ShippingLabelsViewModel>
<ShippingLabelsViewModel>
<CreatedBy>sample string 11</CreatedBy>
<CreatedDate>sample string 7</CreatedDate>
<OrderNumbers>sample string 14</OrderNumbers>
<PackageNumbers>sample string 15</PackageNumbers>
<PickedBy>sample string 9</PickedBy>
<PickedDate>sample string 8</PickedDate>
<ReferenceCode>sample string 2</ReferenceCode>
<ShipDateDisplay>sample string 6</ShipDateDisplay>
<ShipFrom>sample string 3</ShipFrom>
<ShipTo>sample string 4</ShipTo>
<ShipToType>64</ShipToType>
<ShipmentMethod>sample string 16</ShipmentMethod>
<ShipmentStatus>64</ShipmentStatus>
<ShippedBy>sample string 10</ShippedBy>
<ShippingLabelId>1</ShippingLabelId>
<TotalItems>13</TotalItems>
<TotalPackages>12</TotalPackages>
</ShippingLabelsViewModel>
</ArrayOfShippingLabelsViewModel>