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 Creating shipping labels for more information.

Returns shipping label

get

List shipping labels

Query parameters

endingBeforestringOptional

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.

startingAfterstringOptional

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: 100Optional

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

idsstring[]Optional

Only return objects with these IDs.

orderIdstringOptional

The order to retrieve returns for.

Responses

200

200 OK

application/json

400

400 Bad Request

application/json

401

401 Unauthorized

application/json

403

403 Forbidden

application/json

405

405 Method Not Allowed

application/json

406

406 Not Acceptable

application/json

408

408 Request Timeout

application/json

429

429 Too Many Requests

application/json

500

500 Internal Server Error

application/json

502

502 Bad Gateway Error

application/json

503

503 Service Unavailable Error

application/json

504

504 Gateway Timeout Error

application/json

get

HTTPcURLJavaScriptPython

GET /shipping-labels HTTP/1.1
Host: api.digitalriver.com
Accept: */*

{
  "hasMore": true,
  "data": [
    {
      "id": "sdfg-r6w7-hbem-ju764",
      "orderId": "sdfg-r6w7-hbem-ju764",
      "shipments": [
        {
          "id": "string",
          "labels": [
            {
              "height": 5,
              "width": 5,
              "format": "PDF",
              "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"
            }
          ],
          "packages": [
            {
              "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,
                    "weightUnit": "oz",
                    "partNumber": "SWG1224J10L",
                    "partnerAccountId": "00g6atnynbl2wFsFG357"
                  }
                }
              ],
              "weight": 5,
              "weightUnit": "oz",
              "height": 5,
              "width": 5,
              "length": 5
            }
          ]
        }
      ],
      "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": "[e-mail]",
        "organization": "Digital River",
        "additionalAddressInfo": {
          "neighborhood": "Centro",
          "division": "営業部",
          "phoneticName": "ヤマダ タロ"
        }
      }
    }
  ]
}

Returns shipping label

post

Create a shipping label

Body

orderIdstringRequired

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

Example: sdfg-r6w7-hbem-ju764

labelformatstring · enumRequired

The format of the label's data file.

Example: PDFPossible values:

Responses

200

200 OK

application/json

400

400 Bad Request

application/json

401

401 Unauthorized

application/json

403

403 Forbidden

application/json

405

405 Method Not Allowed

application/json

406

406 Not Acceptable

application/json

408

408 Request Timeout

application/json

429

429 Too Many Requests

application/json

500

500 Internal Server Error

application/json

502

502 Bad Gateway Error

application/json

503

503 Service Unavailable Error

application/json

504

504 Gateway Timeout Error

application/json

post

HTTPcURLJavaScriptPython

POST /shipping-labels HTTP/1.1
Host: api.digitalriver.com
Content-Type: application/json
Accept: */*
Content-Length: 1106

{
  "orderId": "sdfg-r6w7-hbem-ju764",
  "labelformat": "PDF",
  "shippingChoice": {
    "id": "100067660336",
    "amount": 5.95,
    "description": "USPS: Priority (1 day delivery)",
    "serviceLevel": "Standard Ground",
    "shippingTerms": "DDP"
  },
  "shipFrom": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "packages": [
    {
      "weight": 5,
      "weightUnit": "oz",
      "height": 5,
      "width": 5,
      "length": 5,
      "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,
            "weightUnit": "oz",
            "partNumber": "SWG1224J10L",
            "partnerAccountId": "00g6atnynbl2wFsFG357"
          },
          "logisticsOptions": {
            "deliveryOptions": [
              "[\"direct_delivery_only\",\"additional_handling\"]"
            ],
            "dangerousGoods": [
              "nimh_battery"
            ]
          },
          "amount": 9.99,
          "quantity": 1
        }
      ]
    }
  ]
}

{
  "id": "sdfg-r6w7-hbem-ju764",
  "orderId": "sdfg-r6w7-hbem-ju764",
  "shipments": [
    {
      "id": "string",
      "labels": [
        {
          "height": 5,
          "width": 5,
          "format": "PDF",
          "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"
        }
      ],
      "packages": [
        {
          "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,
                "weightUnit": "oz",
                "partNumber": "SWG1224J10L",
                "partnerAccountId": "00g6atnynbl2wFsFG357"
              }
            }
          ],
          "weight": 5,
          "weightUnit": "oz",
          "height": 5,
          "width": 5,
          "length": 5
        }
      ]
    }
  ],
  "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": "[e-mail]",
    "organization": "Digital River",
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  }
}

Gets a shipping label by ID

get

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

Path parameters

idstringRequired

Shipping Label ID

Responses

200

OK.

application/json

400

400 Bad Request

application/json

401

401 Unauthorized

application/json

403

403 Forbidden

application/json

404

404 Not Found

application/json

405

405 Method Not Allowed

application/json

406

406 Not Acceptable

application/json

408

408 Request Timeout

application/json

429

429 Too Many Requests

application/json

500

500 Internal Server Error

application/json

502

502 Bad Gateway Error

application/json

503

503 Service Unavailable Error

application/json

504

504 Gateway Timeout Error

application/json

get

HTTPcURLJavaScriptPython

GET /shipping-labels/{id} HTTP/1.1
Host: api.digitalriver.com
Accept: */*

{
  "id": "sdfg-r6w7-hbem-ju764",
  "orderId": "sdfg-r6w7-hbem-ju764",
  "shipments": [
    {
      "id": "string",
      "labels": [
        {
          "height": 5,
          "width": 5,
          "format": "PDF",
          "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"
        }
      ],
      "packages": [
        {
          "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,
                "weightUnit": "oz",
                "partNumber": "SWG1224J10L",
                "partnerAccountId": "00g6atnynbl2wFsFG357"
              }
            }
          ],
          "weight": 5,
          "weightUnit": "oz",
          "height": 5,
          "width": 5,
          "length": 5
        }
      ]
    }
  ],
  "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": "[e-mail]",
    "organization": "Digital River",
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  }
}