Shipping labels

Shipping labels are essential for identifying packages during transit, ensuring that parcels reach their intended destinations efficiently. This resource provides detailed guidance on creating and managing shipping labels, streamlining the fulfillment process, and enhancing delivery accuracy. See for more information.

PreviousShipments NextShipping quotes

Last updated 4 months ago

Gets a shipping label by ID

Retrieves the details of a shipping label. Supply the unique identifier of the shipping label.

get

/shipping-labels/{id}

Path parameters

idstringrequired

Shipping Label ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.digitalriver.com/shipping-labels/{id}'

200

400

401

403

404

405

406

408

429

500

502

503

504

{
  "id": "sdfg-r6w7-hbem-ju764",
  "orderId": "sdfg-r6w7-hbem-ju764",
  "returnTo": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "jsmith@digitalriver.com",
    "organization": "Digital River",
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "shipments": [
    {
      "id": "string",
      "labels": [
        {
          "height": 5,
          "width": 5,
          "file": "JVBERi0xLjQKJeLjz9MKNCAwIG9iago8PC9TdWJ0eXBlL0Zvcm0vRmlsdGVyL0ZsYXRlRGVjb2Rl\\nL1R5cGUvWE9iamVjdC9NYXRyaXggWzEgMCAwIDEgMCAwXS9Gb3JtVHlwZSAxL1Jlc291cmNlczw8\\nL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQiAvSW1hZ2VDIC9JbWFnZUldPj4vQkJveFswIDAg\\nMjMyIDE0NF0vTGVuZ3RoIDEwNDA+PnN0cmVhbQp4nHWYwY4UMQxE7/0V8wmxO52kfwGJAycOiBsC\\nhAAJLvw+s5uqModCI42lnXHZ5WQ7b/LraI/o/fHjGdvj+5FnKr78/fvx9Xh//Dzi8efIx5vnt74d\\n0R5vjw8f2+PT8es1rT1+f5EO87ZOwzu1Pj+VXl7PhETCwIdjF8Z7JajCQMLCh+v1qwPvpsJCQrB+\\n7HYW3k2NoI3ozOmv30ZqWCv48jOLfcRui8nd1qKhpGiiyGBwY9OgNWnMrDGYWslpJ1vJ3RqT09ai\\nr2QriVXqDK6WfHHEuSfOZO+Lq3XSwAlDi8HUOjkN7VdsYCSfdr1OTuNkK+dujcl2/5301SnaUWQw\\nmFqdHXaK9l0Eyd2uV2eHnSPue+RMtuvVu",
          "fileUrl": "www.sample.com",
          "format": "PDF"
        }
      ],
      "packages": [
        {
          "weight": 5,
          "height": 5,
          "width": 5,
          "length": 5,
          "weightUnit": "oz",
          "items": [
            {
              "quantity": 1,
              "itemId": "SWG1224J10L",
              "productDetails": {
                "id": "100067660336",
                "skuGroupId": "wireless-keyboards",
                "name": "Keyboard",
                "description": "Top rated keyboard",
                "itemBreadcrumb": "Sports & Outdoors > Exercise & Fitness > Wearable Technology > Fitness Trackers",
                "url": "https://producturl.com",
                "countryOfOrigin": "US",
                "image": "https://imageurl.com",
                "weight": 20.5,
                "partNumber": "SWG1224J10L",
                "partnerAccountId": "00g6atnynbl2wFsFG357",
                "weightUnit": "oz"
              }
            }
          ]
        }
      ]
    }
  ]
}

OK.

Returns shipping label

List shipping labels

get

/shipping-labels

Query parameters

createdTimeobject

A filter on the list based on the createdTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

eq—return values where the createdTime field equals to this timestamp
gt—return values where the createdTime field is after this timestamp
gte—return values where the createdTime field is after or equal to this timestamp
lt—return values where the createdTime field is before this timestamp
lte—return values where the createdTime field is before or equal to this timestamp

Example: createdTime[gt]=2020-09-22T12:09:44Z

endingBeforestring

A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.

startingAfterstring

A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.

limitinteger · min: 1 · max: 100

A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.

idsstring[]

Only return objects with these IDs.

orderIdstring

The order to retrieve returns for.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.digitalriver.com/shipping-labels'

200

400

401

403

405

406

408

429

500

502

503

504

{
  "hasMore": true,
  "data": [
    {
      "id": "sdfg-r6w7-hbem-ju764",
      "orderId": "sdfg-r6w7-hbem-ju764",
      "returnTo": {
        "address": {
          "line1": "10380 Bren Rd W",
          "line2": "text",
          "city": "Minnetonka",
          "postalCode": "55129",
          "state": "MN",
          "country": "US"
        },
        "name": "John Smith",
        "phone": "952-111-1111",
        "email": "jsmith@digitalriver.com",
        "organization": "Digital River",
        "additionalAddressInfo": {
          "neighborhood": "Centro",
          "division": "営業部",
          "phoneticName": "ヤマダ タロ"
        }
      },
      "shipments": [
        {
          "id": "string",
          "labels": [
            {
              "height": 5,
              "width": 5,
              "file": "JVBERi0xLjQKJeLjz9MKNCAwIG9iago8PC9TdWJ0eXBlL0Zvcm0vRmlsdGVyL0ZsYXRlRGVjb2Rl\\nL1R5cGUvWE9iamVjdC9NYXRyaXggWzEgMCAwIDEgMCAwXS9Gb3JtVHlwZSAxL1Jlc291cmNlczw8\\nL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQiAvSW1hZ2VDIC9JbWFnZUldPj4vQkJveFswIDAg\\nMjMyIDE0NF0vTGVuZ3RoIDEwNDA+PnN0cmVhbQp4nHWYwY4UMQxE7/0V8wmxO52kfwGJAycOiBsC\\nhAAJLvw+s5uqModCI42lnXHZ5WQ7b/LraI/o/fHjGdvj+5FnKr78/fvx9Xh//Dzi8efIx5vnt74d\\n0R5vjw8f2+PT8es1rT1+f5EO87ZOwzu1Pj+VXl7PhETCwIdjF8Z7JajCQMLCh+v1qwPvpsJCQrB+\\n7HYW3k2NoI3ozOmv30ZqWCv48jOLfcRui8nd1qKhpGiiyGBwY9OgNWnMrDGYWslpJ1vJ3RqT09ai\\nr2QriVXqDK6WfHHEuSfOZO+Lq3XSwAlDi8HUOjkN7VdsYCSfdr1OTuNkK+dujcl2/5301SnaUWQw\\nmFqdHXaK9l0Eyd2uV2eHnSPue+RMtuvVu",
              "fileUrl": "www.sample.com",
              "format": "PDF"
            }
          ],
          "packages": [
            {
              "weight": 5,
              "height": 5,
              "width": 5,
              "length": 5,
              "weightUnit": "oz",
              "items": [
                {
                  "quantity": 1,
                  "itemId": "SWG1224J10L",
                  "productDetails": {
                    "id": "100067660336",
                    "skuGroupId": "wireless-keyboards",
                    "name": "Keyboard",
                    "description": "Top rated keyboard",
                    "itemBreadcrumb": "Sports & Outdoors > Exercise & Fitness > Wearable Technology > Fitness Trackers",
                    "url": "https://producturl.com",
                    "countryOfOrigin": "US",
                    "image": "https://imageurl.com",
                    "weight": 20.5,
                    "partNumber": "SWG1224J10L",
                    "partnerAccountId": "00g6atnynbl2wFsFG357",
                    "weightUnit": "oz"
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

200 OK

Returns shipping label

Create a shipping label

post

/shipping-labels

Body

orderIdstringrequired

The identifier of the order in Digital River's system.

Example: sdfg-r6w7-hbem-ju764

shippingChoiceShippingRequest

Represents the shipping amount, description, taxes, and service level.

shipFromGLShipFrom

The address of the warehouse from which a physical product is shipped.

labelformatstring · enumrequired

The format of the label's data file.

Example: PDF

Options: PDF, PNG, JPG, ZPL

packagesPackageRequest[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/shipping-labels' \
  --header 'Content-Type: application/json' \
  --data '{"orderId":"sdfg-r6w7-hbem-ju764","shippingChoice":{"id":"100067660336","amount":5.95,"description":"USPS: Priority (1 day delivery)","serviceLevel":"Standard Ground","shippingTerms":"DDP"},"shipFrom":{"address":{"line1":"10380 Bren Rd W","city":"Minnetonka","postalCode":"55129","state":"MN","country":"US"},"additionalAddressInfo":{"neighborhood":"Centro","division":"営業部","phoneticName":"ヤマダ タロ"}},"labelformat":"PDF","packages":[{"weight":5,"height":5,"width":5,"length":5,"weightUnit":"oz","items":[{"productDetails":{"id":"100067660336","skuGroupId":"wireless-keyboards","name":"Keyboard","description":"Top rated keyboard","itemBreadcrumb":"Sports & Outdoors > Exercise & Fitness > Wearable Technology > Fitness Trackers","url":"https://producturl.com","countryOfOrigin":"US","image":"https://imageurl.com","weight":20.5,"partNumber":"SWG1224J10L","partnerAccountId":"00g6atnynbl2wFsFG357","weightUnit":"oz"},"logisticsOptions":{"deliveryOptions":["[\"direct_delivery_only\",\"additional_handling\"]"],"dangerousGoods":["nimh_battery"]},"amount":9.99,"quantity":1}]}]}'

200

400

401

403

405

406

408

429

500

502

503

504

{
  "id": "sdfg-r6w7-hbem-ju764",
  "orderId": "sdfg-r6w7-hbem-ju764",
  "returnTo": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "jsmith@digitalriver.com",
    "organization": "Digital River",
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "shipments": [
    {
      "id": "string",
      "labels": [
        {
          "height": 5,
          "width": 5,
          "file": "JVBERi0xLjQKJeLjz9MKNCAwIG9iago8PC9TdWJ0eXBlL0Zvcm0vRmlsdGVyL0ZsYXRlRGVjb2Rl\\nL1R5cGUvWE9iamVjdC9NYXRyaXggWzEgMCAwIDEgMCAwXS9Gb3JtVHlwZSAxL1Jlc291cmNlczw8\\nL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQiAvSW1hZ2VDIC9JbWFnZUldPj4vQkJveFswIDAg\\nMjMyIDE0NF0vTGVuZ3RoIDEwNDA+PnN0cmVhbQp4nHWYwY4UMQxE7/0V8wmxO52kfwGJAycOiBsC\\nhAAJLvw+s5uqModCI42lnXHZ5WQ7b/LraI/o/fHjGdvj+5FnKr78/fvx9Xh//Dzi8efIx5vnt74d\\n0R5vjw8f2+PT8es1rT1+f5EO87ZOwzu1Pj+VXl7PhETCwIdjF8Z7JajCQMLCh+v1qwPvpsJCQrB+\\n7HYW3k2NoI3ozOmv30ZqWCv48jOLfcRui8nd1qKhpGiiyGBwY9OgNWnMrDGYWslpJ1vJ3RqT09ai\\nr2QriVXqDK6WfHHEuSfOZO+Lq3XSwAlDi8HUOjkN7VdsYCSfdr1OTuNkK+dujcl2/5301SnaUWQw\\nmFqdHXaK9l0Eyd2uV2eHnSPue+RMtuvVu",
          "fileUrl": "www.sample.com",
          "format": "PDF"
        }
      ],
      "packages": [
        {
          "weight": 5,
          "height": 5,
          "width": 5,
          "length": 5,
          "weightUnit": "oz",
          "items": [
            {
              "quantity": 1,
              "itemId": "SWG1224J10L",
              "productDetails": {
                "id": "100067660336",
                "skuGroupId": "wireless-keyboards",
                "name": "Keyboard",
                "description": "Top rated keyboard",
                "itemBreadcrumb": "Sports & Outdoors > Exercise & Fitness > Wearable Technology > Fitness Trackers",
                "url": "https://producturl.com",
                "countryOfOrigin": "US",
                "image": "https://imageurl.com",
                "weight": 20.5,
                "partNumber": "SWG1224J10L",
                "partnerAccountId": "00g6atnynbl2wFsFG357",
                "weightUnit": "oz"
              }
            }
          ]
        }
      ]
    }
  ]
}

200 OK