Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Shipping Labels

Returns shipping label

Create a shipping label

post/shipping-labels

Request body

orderIdstring 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.

Example request

{
  "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",
      "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
        }
      ]
    }
  ]
}

Response

200 OK

idstring

The shipping label identifier

orderIdstring

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

Example response

{
  "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",
      "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": "ヤマダ タロ"
    }
  }
}