POST v1/api/Labelling/Label
Request Information
URI Parameters
None.
Body Parameters
LabelRequestName | Description | Type | Additional information |
---|---|---|---|
BrandCode | string |
None. |
|
PackageDimensions | Dimension |
None. |
|
CashOnDelivery | boolean |
None. |
|
OrderNumber | string |
None. |
|
PackageId | string |
None. |
|
AsnPackageStatus | string |
None. |
|
Weight | decimal number |
None. |
|
WeightUnit | string |
None. |
|
GoodsDescription | string |
None. |
|
ServiceLevel | string |
None. |
|
IsOrderPackageEddu | string |
None. |
|
TrackingNumber | string |
None. |
|
Customer | AsnConsignee |
None. |
|
Items | Collection of AsnPackageItem |
None. |
|
CarrierPackageReference | string |
None. |
|
DimHeight | decimal number |
None. |
|
DimWidth | decimal number |
None. |
|
DimLength | decimal number |
None. |
|
DimUnit | string |
None. |
|
OriginWarehouse | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "BrandCode": "sample string 1", "PackageDimensions": { "Length": 1.1, "Width": 2.1, "Height": 3.1, "DimensionUnit": "M" }, "CashOnDelivery": true, "OrderNumber": "sample string 3", "PackageId": "sample string 4", "AsnPackageStatus": "New", "Weight": 6.1, "WeightUnit": "Lb", "GoodsDescription": "sample string 8", "ServiceLevel": "sample string 9", "IsOrderPackageEddu": "True", "TrackingNumber": "sample string 11", "Customer": { "FirstName": "sample string 1", "LastName": "sample string 2", "Gender": "Unknown", "Email": "sample string 4", "Telephone": "sample string 5", "Address1": "sample string 6", "Address2": "sample string 7", "City": "sample string 8", "Country": "sample string 9", "POBox": "sample string 10", "PostalCode": "sample string 11", "Region": "sample string 12", "Unit": "sample string 13" }, "Items": [ null, { "ProductCode": "sample string 1", "OrderItemLineId": 2, "Quantity": null, "CountryOfOrigin": null, "Weight": 0.0, "WeightUnit": null, "UnitPrice": null, "EdduPackageItemDetails": { "ProductDescription": null, "ProductCustomsDescription": null, "Currency": null, "HsCode": null } } ], "CarrierPackageReference": "sample string 13", "DimHeight": 14.0, "OriginWarehouse": "sample string 18", "DimWidth": 15.0, "DimLength": 16.0, "DimUnit": "sample string 17" }
application/x-www-form-urlencoded
Sample:
Sample not available.
application/xml, text/xml
Sample:
<LabelRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <OrderNumber>sample string 3</OrderNumber> <PackageId>sample string 4</PackageId> <AsnPackageStatus>New</AsnPackageStatus> <Weight>6.1</Weight> <WeightUnit>Lb</WeightUnit> <GoodsDescription>sample string 8</GoodsDescription> <ServiceLevel>sample string 9</ServiceLevel> <IsOrderPackageEddu>True</IsOrderPackageEddu> <TrackingNumber>sample string 11</TrackingNumber> <Customer> <FirstName>sample string 1</FirstName> <LastName>sample string 2</LastName> <Gender>Unknown</Gender> <Email>sample string 4</Email> <Telephone>sample string 5</Telephone> <Address1>sample string 6</Address1> <Address2>sample string 7</Address2> <City>sample string 8</City> <Country>sample string 9</Country> <PoBox>sample string 10</PoBox> <PostalCode>sample string 11</PostalCode> <Region>sample string 12</Region> <Unit>sample string 13</Unit> </Customer> <Items> <AsnPackageItem xsi:nil="true" /> <AsnPackageItem> <ProductCode>sample string 1</ProductCode> <OrderItemLineId>2</OrderItemLineId> <Weight>0</Weight> <EdduPackageItemDetails /> </AsnPackageItem> </Items> <CarrierPackageReference>sample string 13</CarrierPackageReference> <DimHeight>14</DimHeight> <DimWidth>15</DimWidth> <DimLength>16</DimLength> <DimUnit>sample string 17</DimUnit> <OriginWarehouse>sample string 18</OriginWarehouse> <BrandCode>sample string 1</BrandCode> <PackageDimensions> <Length>1.1</Length> <Width>2.1</Width> <Height>3.1</Height> <DimensionUnit>M</DimensionUnit> </PackageDimensions> <CashOnDelivery>true</CashOnDelivery> </LabelRequest>
Response Information
Resource Description
LabelResponseName | Description | Type | Additional information |
---|---|---|---|
DeliverLabel | CarrierLabel |
None. |
|
PackageInfo | CarrierPackageInfo |
None. |
|
CommercialInvoice | CommercialInvoice |
None. |
|
Status | GetLabelStatus |
None. |
|
StatusMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "DeliverLabel": { "DataFormat": 0, "Data": "sample string 1" }, "PackageInfo": { "CarrierPackageReference": "sample string 1", "SortNumber": "sample string 2" }, "CommercialInvoice": { "DataFormat": 0, "Data": "sample string 1", "PrintCopies": 2 }, "Status": 0, "StatusMessage": "sample string 1" }
application/xml, text/xml
Sample:
<LabelResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Status>Success</Status> <StatusMessage>sample string 1</StatusMessage> <DeliverLabel> <DataFormat>Zpl</DataFormat> <Data>sample string 1</Data> </DeliverLabel> <PackageInfo> <CarrierPackageReference>sample string 1</CarrierPackageReference> <SortNumber>sample string 2</SortNumber> </PackageInfo> <CommercialInvoice> <DataFormat>Zpl</DataFormat> <Data>sample string 1</Data> <PrintCopies>2</PrintCopies> </CommercialInvoice> </LabelResponse>