GET
/
v1
/
customers
/
{customerId}
/
orders
curl --request GET \
  --url https://prod01.copilot.fabric.inc/data-subscription/v1/customers/{customerId}/orders \
  --header 'Authorization: Bearer <token>'
{
  "responseStatus": "OK",
  "message": "Request processed successfully",
  "data": {
    "orders": [
      {
        "shipTo": {
          "name": {
            "firstName": "Pat",
            "middleName": "E",
            "lastName": "Kake"
          },
          "streetAddress": {
            "street1": "123 Main St",
            "street2": "Suite 100"
          },
          "city": "Boston",
          "state": "MA",
          "postalCode": "02127",
          "country": "US",
          "phone": {
            "number": "5555551234",
            "kind": "home"
          }
        },
        "billTo": {
          "name": {
            "firstName": "Pat",
            "middleName": "E",
            "lastName": "Kake"
          },
          "streetAddress": {
            "street1": "123 Main St",
            "street2": "Suite 100"
          },
          "city": "Boston",
          "state": "MA",
          "postalCode": "02127",
          "country": "US",
          "phone": {
            "number": "5555551234",
            "kind": "home"
          }
        },
        "paymentDetails": {
          "paymentIdentifier": {
            "cardIdentifier": "1234",
            "expiryDate": "12/20"
          },
          "paymentMethod": "credit_card",
          "paymentKind": "Visa"
        },
        "isDeleted": false,
        "deletedAt": "2019-01-01T00:00:00.000Z",
        "id": "6384462ab645220008a4358a",
        "status": "SCHEDULED",
        "totalAmount": 100,
        "totalTax": 10,
        "totalDiscount": 10,
        "currencyCode": "USD",
        "scheduledDate": "2019-01-01T00:00:00.000Z",
        "customer": {
          "customerReferenceId": "12345",
          "locale": "en_US",
          "email": "customer@example.com",
          "contactnumber": "5555551234",
          "firstName": "Pat",
          "middleName": "E",
          "lastName": "Kake",
          "segments": [
            "employee"
          ],
          "employeeId": "345",
          "status": "ACTIVE",
          "isDeleted": false,
          "DeletedAt": "2021-01-01T00:00:00.000Z",
          "createdAt": "2019-10-12T21:35:05.756Z",
          "updatedAt": "2021-10-14T05:40:55.997Z",
          "communicationPreference": {
            "email": true,
            "sms": true
          }
        },
        "lineItems": [
          {
            "subscription": {
              "plan": {
                "id": "1001",
                "frequency": 30,
                "frequencyType": "Daily"
              },
              "id": "6256610bc312410009b7390b"
            },
            "item": {
              "id": 1000000006,
              "sku": "MOBO-X570",
              "quantity": 1,
              "weight": 10,
              "weightUnit": "lb",
              "title": "Vitamin",
              "description": "Vitamin C",
              "itemPrice": {
                "price": 100,
                "currencyCode": "USD"
              },
              "tax": {
                "taxCode": "FR020000",
                "taxAmount": 10,
                "currencyCode": "USD"
              }
            },
            "shipping": {
              "shipmentCarrier": "USPS",
              "shipmentMethod": "Ground",
              "shipmentInstructions": "Please leave the package in the box",
              "taxCode": "SHP020000",
              "shippingAmount": 10,
              "taxAmount": 1,
              "currencyCode": "USD"
            },
            "offer": {
              "id": "SUB-E10717",
              "source": "PDP"
            },
            "lineItemId": 1,
            "customAttributes": {
              "storeId": "60cb07fc20387b000821c5c3",
              "associateId": 1,
              "trackingUrl": "609436d21baded0008945b05"
            }
          }
        ],
        "createdAt": "2021-10-12T21:35:05.756Z",
        "updatedAt": "2021-10-14T05:40:55.997Z",
        "statusUpdatedAt": "2021-10-14T10:24:36.468Z",
        "Retry": {
          "maxRetries": 3,
          "retryType": "PAYMENT RETRY",
          "retryAfterDays": 1,
          "retryCount": 2
        },
        "error": {
          "errorCode": "ORDER_NOT_FOUND",
          "errorMessage": "The order is not found"
        }
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
customerId
string
required

Customer reference ID

Response

200
application/json
Request processed successfully

Get orders by customer reference ID

​
responseStatus
string

Brief response status

​
message
string

Full response message

​
data
object

Order details

Was this page helpful?

Update single orderSkip single order