Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Fulfillments

Gets a Fulfillment by unique identifier

Retrieves the details of a Fulfillment.

get/fulfillments/{id}

Path parameters

idstring required

The unique identifier of a Fulfillment.

Response

OK.

idstring

The unique identifier of the Fulfillment.

createdTimestring date-time

The time when the Fulfillment was created.

orderIdstring

The unique identifier of the Order associated with this Fulfillment.

shipmentIdstring

The unique identifier associated to the shipment

liveModeboolean

Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.

metadataMetadata

Key-value pairs used to store additional data. Value can be string, boolean or integer types.

trackingCompanystring

The name of the tracking company.

trackingNumberstring

A tracking number provided by the shipping company.

trackingUrlstring

The URL of the tracking page for the Fulfillment.

Example response

{
  "id": "ful_25c651d0-8079-48d7-b22e-eb1e2f451966",
  "createdTime": "2018-04-25T20:36:00Z",
  "orderId": "ord_5678901234",
  "orderDetails": {
    "id": "ord_5823594809",
    "checkoutId": "5823594809",
    "createdTime": "2018-04-25T20:36:00Z",
    "customerId": "cus_5774321009",
    "currency": "usd",
    "email": "jsmith@digitalriver.com",
    "locale": "en_US",
    "browserIp": "111.111.111.111",
    "applicationId": "68f72e0c-cb7d-48e1-93c8-998668ad0ff4",
    "taxIdentifiers": [
      {
        "id": "5774321009",
        "createdTime": "2018-04-25T20:36:00Z",
        "customerId": "5774321009",
        "type": "de",
        "value": "DE123456789",
        "state": "pending",
        "stateTransitions": {
          "pending": "2018-04-25T20:36:00Z",
          "verified": "2018-04-25T20:36:00Z",
          "not_valid": "2018-04-25T20:36:00Z"
        },
        "verifiedName": ".",
        "verifiedAddress": ".",
        "updatedTime": "2018-04-25T20:36:00Z"
      }
    ],
    "invoiceAttributes": {
      "id": "1234",
      "type": "cn_business_general",
      "customerId": "5678",
      "atttributes": [
        {
          "invoiceTitle": "Invoice title",
          "regAccount": "87654",
          "regAddress": "123 Example st.",
          "regBank": "Bank",
          "regPhone": "8005551234"
        }
      ],
      "createdTime": "2018-04-25T20:36:00Z",
      "updatedTime": "2018-04-25T20:36:00Z"
    },
    "shipFrom": {
      "address": {
        "line1": "10380 Bren Rd W",
        "city": "Minnetonka",
        "postalCode": "55129",
        "state": "MN",
        "country": "US"
      },
      "additionalAddressInfo": {
        "neighborhood": "Centro",
        "division": "営業部",
        "phoneticName": "ヤマダ タロ"
      }
    },
    "shipTo": {
      "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": "ヤマダ タロ"
      }
    },
    "billTo": {
      "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": "ヤマダ タロ"
      }
    },
    "organization": {
      "id": "123456789"
    },
    "subtotal": 1094.5,
    "totalTax": 82.76,
    "totalImporterTax": 82.76,
    "importerOfRecordTax": true,
    "totalShipping": 5.76,
    "totalAmount": 1180.26,
    "discount": {
      "amountOff": 5.95,
      "percentOff": 100
    },
    "availableToRefundAmount": 18.58,
    "items": [
      {
        "id": "100067660336",
        "skuId": "sku_5823594809",
        "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"
          ]
        },
        "subscriptionInfo": {
          "freeTrial": true,
          "autoRenewal": true,
          "terms": "Please accept these terms.",
          "planId": "654321",
          "subscriptionId": "665430999",
          "billingAgreementId": "cfeba2ac-d532-49e4-99f4-7a433507facf",
          "startTime": "2020-05-21T00:00:00Z",
          "endTime": "2021-05-20T11:59:59Z"
        },
        "fees": {
          "details": [
            {
              "type": "battery",
              "amount": 3,
              "perUnitAmount": 1.5,
              "id": "asdkj1h239lkj123j9123"
            }
          ],
          "amount": 4.5,
          "taxAmount": 1.2
        },
        "quantity": 2,
        "state": "created",
        "amount": 18.58,
        "availableToRefundAmount": 18.58,
        "sellerTaxIdentifier": "IE6426071C",
        "tax": {
          "rate": 0.0675,
          "amount": 89
        },
        "importerTax": {
          "amount": 12.34
        },
        "duties": {
          "amount": 12.34
        },
        "discount": {
          "amountOff": 5.95,
          "percentOff": 100,
          "quantity": 1
        },
        "shipFrom": {
          "address": {
            "line1": "10380 Bren Rd W",
            "city": "Minnetonka",
            "postalCode": "55129",
            "state": "MN",
            "country": "US"
          },
          "additionalAddressInfo": {
            "neighborhood": "Centro",
            "division": "営業部",
            "phoneticName": "ヤマダ タロ"
          }
        },
        "shipping": {
          "amount": 5.99,
          "taxAmount": 1.99
        },
        "metadata": {
          "coupon": "iOS"
        }
      }
    ],
    "requestToBeForgotten": true,
    "shippingChoice": {
      "id": "100067660336",
      "amount": 5.95,
      "taxAmount": 0.1,
      "description": "USPS: Priority (1 day delivery)",
      "serviceLevel": "Standard Ground",
      "shippingTerms": "DDP"
    },
    "state": "created",
    "fraudState": "passed",
    "metadata": {
      "coupon": "iOS"
    },
    "sellingEntity": {
      "id": "C5_INC-ENTITY",
      "name": "DR globalTech Inc."
    },
    "purchaseLocation": {
      "country": "US",
      "state": "MN",
      "postalCode": "55364"
    },
    "customerType": "individual",
    "upstreamId": "0916805858",
    "updatedTime": "2018-04-25T20:37:00Z"
  },
  "shipmentId": "321765",
  "items": [
    {
      "itemId": "98784590336",
      "skuId": "98784590336",
      "shipmentItemId": "321765",
      "quantity": 1,
      "cancelQuantity": 1,
      "trackingCompany": "Fedex",
      "trackingNumber": "5678901234",
      "trackingUrl": "http://www.digitalriver.com?code=5678901234",
      "subfulfillerId": "hjueo9g",
      "distributorCost": 10,
      "shippingCost": 10
    }
  ],
  "metadata": {
    "coupon": "iOS"
  },
  "trackingCompany": "Fedex",
  "trackingNumber": "5678901234",
  "trackingUrl": "http://www.digitalriver.com?code=5678901234"
}