---
title: "Returns shipping label"
method: GET
path: "/shipping-labels"
tags: ["Shipping Labels"]
---

# Returns shipping label

`GET /shipping-labels`

List shipping labels

## Query parameters

- `createdTime` object
- `endingBefore` string
- `startingAfter` string
- `limit` integer
- `ids` string[]
- `orderId` string

## Response `200`

200 OK

- object
  - `hasMore` boolean — Whether or not there are more elements available after this set. If false this set represents the end of the list.
  - `data` ShippingLabelResponse[]
    - `id` string — The shipping label identifier
    - `orderId` string — The identifier of the order in Digital River's system.
    - `shipments` Shipments[]
      - `id` string — The unique identifier of the shipment.
      - `labels` LabelResponse[]
        - `height` integer — The label’s height in inches.
        - `width` integer — The label’s width in inches.
        - `format` 'PDF' | 'PNG' | 'JPG' | 'ZPL' — The format of the label's data file.
        - `file` string — The shipping label data.
        - `fileUrl` string — The URL of the shipping label file.
      - `packages` Packages[]
        - `items` ProductItem[], required
          - `quantity` integer, required
          - `itemId` string, required — Digital River's line item identifier from the order
          - `productDetails` ProductDetails
            - `id` string — The identifier of the product in the upstream system.
            - `skuGroupId` string — The identifier of the SKU group.
            - `name` string — The name of the product.
            - `description` string — The description of the product.
            - `itemBreadcrumb` string — The full path to the category where item is included. Categories should be separated by “ > “.
            - `url` string — The product url.
            - `countryOfOrigin` string — The country of origin of the product.
            - `image` string — The image of the product.
            - `weight` number, double — The weight of the product measured in the unit specified by weightUnit.
            - `weightUnit` 'oz' | 'lb' | 'g' | 'kg' — The unit of measurement applied to the weight.
            - `partNumber` string — The manufacturer's part number.
            - `partnerAccountId` string — The unique, Digital River identifier (account Id) of the partner associated with the sku.
        - `weight` integer — The box’s weight.
        - `weightUnit` 'oz' | 'lb' | 'g' | 'kg' — The box’s weight unit.
        - `height` integer — The box’s height.
        - `width` integer — The box’s width.
        - `length` integer — The box’s length.
    - `returnTo` Shipping
      - `address` Address — Represents basic address information.
        - `line1` string, nullable — The first line of the address.
        - `line2` string — The second line of the address.
        - `city` string, nullable — The city of the address.
        - `postalCode` string, nullable — The postal code of the address.
        - `state` string, nullable — The state, county, province, or region.
        - `country` string, required — A [two-letter Alpha-2 country code](https://www.iban.com/country-codes) as described in the [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) international standard.
      - `name` string, nullable — The recipient’s name.
      - `phone` string, nullable — The recipient’s phone number.
      - `email` string, email, nullable — The recipient’s email address.
      - `organization` string, nullable — The recipient’s organization.
      - `additionalAddressInfo` AdditionalAddressInfo — Captures any information that's not included in the basic address.
        - `neighborhood` string, nullable — The neighborhood of the address.
        - `division` string, nullable — A division within an organization.
        - `phoneticName` string, nullable — The phonetic spelling of a name.

## Other responses

- `400` — 400 Bad Request
- `401` — 401 Unauthorized
- `403` — 403 Forbidden
- `405` — 405 Method Not Allowed
- `406` — 406 Not Acceptable
- `408` — 408 Request Timeout
- `429` — 429 Too Many Requests
- `500` — 500 Internal Server Error
- `502` — 502 Bad Gateway Error
- `503` — 503 Service Unavailable Error
- `504` — 504 Gateway Timeout Error

---

[API](https://skmtc.net/digitalriver/apis/digital-river-api-reference.md) · [All operations](https://skmtc.net/digitalriver/apis/digital-river-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/digitalriver/digital-river-api-reference/revisions/f21981db32be/schema)