--- title: "Returns shipping label" method: POST path: "/shipping-labels" tags: ["Shipping Labels"] --- # Returns shipping label `POST /shipping-labels` Create a shipping label ## Request body - ShippingLabelRequest - `orderId` string, required — The identifier of the order in Digital River's system. - `labelformat` 'PDF' | 'PNG' | 'JPG' | 'ZPL', required — The format of the label's data file. - `shippingChoice` ShippingRequest, nullable — Represents the shipping amount, description, taxes, and service level. - `id` string — The unique identifier of the shipment. - `amount` number, double — The shipping amount. - `description` string — A description of the shipping choice. - `serviceLevel` string — A shipping code that represents the service level. - `shippingTerms` 'DDP' | 'DAP' — The options for paying a transaction's full landed cost amount. DDP (Delivered Duty Paid) allows customers to pay the full amount during checkout. DAP (Deliverated At Place) allows customers to pay product and shipping costs at checkout, while paying duties, fees, and import fees upon delivery. - `shipFrom` GLShipFrom — The address of the warehouse from which a physical product is shipped. - `address` GLAddress — 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 — 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. - `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. - `packages` PackageRequest[], required - `weight` integer, required — Represents the scale weight of the package (i.e., with the goods and dunnage inside of it) at the warehouse and must be greater than 0. If you don't have a [default package weight](https://docs.digitalriver.com/digital-river-api/using-our-services/global-logistics#default-box) saved to your account, then its required. - `weightUnit` 'oz' | 'lb' | 'g' | 'kg', required — The box’s weight unit. - `height` integer — Represents the actual height of the package at the warehouse and must be greater than 0. If you don't have a [default package height](https://docs.digitalriver.com/digital-river-api/using-our-services/global-logistics#default-box) saved to your account, then its required. - `width` integer — Represents the actual width of the package at the warehouse and must be greater than 0. If you don't have a [default package width](https://docs.digitalriver.com/digital-river-api/using-our-services/global-logistics#default-box) saved to your account, then its required. - `length` integer — Represents the actual length of the package at the warehouse and must be greater than 0. If you don't have a [default package length](https://docs.digitalriver.com/digital-river-api/using-our-services/global-logistics#default-box) saved to your account, then its required. - `items` ProductItemRequest[], required - `productDetails` ProductDetails, required - `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. - `logisticsOptions` ItemLogisticsOptions — In the [Global Logistics](https://docs.digitalriver.com/digital-river-api/using-our-services/global-logistics) solution, logisticsOptions allows you to define a list of services that you want the carrier to provide. If you select any of these options, the appropriate fees are added to the shipping quotes that customers select from during the checkout process and the necessary information is added to shipping labels during the fulfillment process.

There are two ways to provide these logisticsOptions. You can either (1) store them in the product's [SKU Group](https://docs.digitalriver.com/digital-river-api/product-management/setting-up-sku-groups) or (2) pass them in checkout and shipping quotes requests at run-time. If you take the second approach, and logisticsOptions exist in a request, then you’re required to define a list of deliveryOptions and/or dangerousGoods.

In either case, we pass your selected options to the [Global Logistics Provider](https://docs.digitalriver.com/digital-river-api/using-our-services/global-logistics#global-logistics-providers) so that the carrier is made aware that these services need to be provided. - `deliveryOptions` string[] —
A set of value-added services offered by the [Global Logistics Provider](https://docs.digitalriver.com/digital-river-api/using-our-services/global-logistics#global-logistics-providers). They provide additional assurances that packages are delivered successfully and that shipping rates are appropriately calculated.

signature_required - Requires that an individual signs for the package at the time of delivery.

adult_signature_required - Requires that an individual who is at least 21 years of age signs for the package at the time of delivery. It’s useful for high-value, dangerous, and age-sensitive items, or as a prevention against theft. After an adult signs for the delivery, the purchaser receives a notification that contains an image of that signature, along with other delivery details.

direct_delivery_only - Ensures that the package is only delivered to the address provided by the customer at the time of purchase. In other words, the package can't be redirected to another address. No signature is required with this option, so if that's something you'd like to collect, you'll need to add signature_required or adult_signature_required to deliveryOptions.

additional_handling - Indicates that a product requires special handling because it's heavy and/or shipped in a large package. If you select this option, then a surcharge is automatically added to each shipping quote that customers select from, regardless of the package’s weight or dimensions.

However, if additional_handling doesn’t exist, but the weight and dimensional values in the request exceed thresholds established by the carrier, that same surcharge is still applied.

Using additional_handling can help minimize your financial risk. This is because if a package’s dimensions and weight are omitted or incorrectly defined in a request and the actual scale weight of the package at the time of shipment exceeds the carrier defined thresholds, thereby incurring a surcharge, then the customer will have underpaid for shipping at checkout, leaving you to make up the difference.

- `dangerousGoods` string[] — Indicates that the product poses unreasonable health, safety, or property risks when shipped and therefore requires special packaging, handling, and modes of transportation. For example, some products, such as lithium batteries and (in)flammable perfumes, are susceptible to static electricity as well as temperature and pressure variations. These forces can cause them to leak, emit toxic fumes, ignite, or even explode.

If a product is considered hazardous, and you opt not to store this information in its [SKU Group](https://docs.digitalriver.com/digital-river-api/product-management/setting-up-sku-groups), then dangerousGoods must list the category it falls into. - `amount` number, double — The amount of the product. - `quantity` integer, required ## Response `200` 200 OK - 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)