--- title: "GetShipmentLabels" method: GET path: "/vendor/shipping/v1/transportLabels" tags: ["Vendor Shipments v1"] --- # GetShipmentLabels `GET /vendor/shipping/v1/transportLabels` Returns small parcel shipment labels based on the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). ## Query parameters - `limit` integer - `sortOrder` 'ASC' | 'DESC' - `nextToken` string - `labelCreatedAfter` string, date-time - `labelCreatedBefore` string, date-time - `buyerReferenceNumber` string - `vendorShipmentIdentifier` string - `sellerWarehouseCode` string ## Response `200` Success. - GetShipmentLabels — The response schema for the GetShipmentLabels operation. - `payload` TransportationLabels — The request schema for the GetShipmentLabels operation. - `pagination` Pagination — The pagination elements required to retrieve the remaining data. - `nextToken` string — A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more shipment items to return. - `transportLabels` TransportLabel[] — A list of one or more ShipmentLabels. - `labelCreateDateTime` string, date-time — Date on which label is created. - `shipmentInformation` ShipmentInformation — Shipment Information details for Label request. - `vendorDetails` VendorDetails — Vendor Details as part of Label response. - `sellingParty` PartyIdentification — Name/Address and tax details of the party. - `address` Address — Address of the party. - … - `partyId` string, required — Assigned identification for the party. - `taxRegistrationDetails` TaxRegistrationDetails[] — Tax registration details of the entity. - … - `vendorShipmentIdentifier` string — Unique vendor shipment id which is not used in last 365 days - `buyerReferenceNumber` string — The buyer reference number is a unique identifier generated by the buyer for all Collect and WePay shipments. - `shipToParty` PartyIdentification — Name/Address and tax details of the party. - `address` Address — Address of the party. - `name` string, required — The name of the person, business or institution at that address. - `addressLine1` string, required — First line of the address. - `addressLine2` string — Additional street address information, if required. - `addressLine3` string — Additional street address information, if required. - `city` string — The city where the person, business or institution is located. - `county` string — The county where person, business or institution is located. - `district` string — The district where person, business or institution is located. - `stateOrRegion` string — The state or region where person, business or institution is located. - `postalCode` string — The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation. - `countryCode` string, required — The two digit country code in ISO 3166-1 alpha-2 format. - `phone` string — The phone number of the person, business or institution located at that address. - `partyId` string, required — Assigned identification for the party. - `taxRegistrationDetails` TaxRegistrationDetails[] — Tax registration details of the entity. - `taxRegistrationType` 'VAT' | 'GST', required — Tax registration type for the entity. - `taxRegistrationNumber` string, required — Tax registration number for the entity. For example, VAT ID. - `shipFromParty` PartyIdentification — Name/Address and tax details of the party. - `address` Address — Address of the party. - `name` string, required — The name of the person, business or institution at that address. - `addressLine1` string, required — First line of the address. - `addressLine2` string — Additional street address information, if required. - `addressLine3` string — Additional street address information, if required. - `city` string — The city where the person, business or institution is located. - `county` string — The county where person, business or institution is located. - `district` string — The district where person, business or institution is located. - `stateOrRegion` string — The state or region where person, business or institution is located. - `postalCode` string — The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation. - `countryCode` string, required — The two digit country code in ISO 3166-1 alpha-2 format. - `phone` string — The phone number of the person, business or institution located at that address. - `partyId` string, required — Assigned identification for the party. - `taxRegistrationDetails` TaxRegistrationDetails[] — Tax registration details of the entity. - `taxRegistrationType` 'VAT' | 'GST', required — Tax registration type for the entity. - `taxRegistrationNumber` string, required — Tax registration number for the entity. For example, VAT ID. - `warehouseId` string — Vendor Warehouse ID from where the shipment is scheduled to be picked up by buyer / Carrier. - `masterTrackingId` string — Unique Id with which the shipment can be tracked for Small Parcels. - `totalLabelCount` integer — Number of Labels that are created as part of this shipment. - `shipMode` 'SmallParcel' | 'LTL' — Type of shipment whether it is Small Parcel - `labelData` LabelData[] — Indicates the label data,format and type associated . - `labelSequenceNumber` integer — A sequential number assigned to each label within a shipment. - `labelFormat` 'PDF' — The format of the label. - `carrierCode` string — Unique identification of the carrier. - `trackingId` string — Tracking Id for the transportation. - `label` string — The base-64 encoded string that represents the shipment label. - `errors` Error[] — A list of error responses returned when a request is unsuccessful. - `code` string, required — An error code that identifies the type of error that occurred. - `message` string, required — A message that describes the error condition. - `details` string — Additional details that can help the caller understand or fix the issue. ## Other responses - `400` — Request has missing or invalid parameters and cannot be parsed. - `401` — The request's Authorization header is not formatted correctly or does not contain a valid token. - `403` — Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. - `404` — The resource specified does not exist. - `415` — The request payload is in an unsupported format. - `429` — The frequency of requests was greater than allowed. - `500` — An unexpected condition occurred that prevented the server from fulfilling the request. - `503` — Temporary overloading or maintenance of the server. --- [API](https://skmtc.net/aws-samples/apis/a-content-management-v2020-11-01.md) · [All operations](https://skmtc.net/aws-samples/apis/a-content-management-v2020-11-01/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws-samples/a-content-management-v2020-11-01/revisions/815a5b6dbaa6/schema)