GET
/
api-offers
/
get-product
/
{sku}
curl --request GET \
  --url https://live.copilot.fabric.inc/api-offers/get-product/{sku} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'
{
  "id": "60c789cfe6e0910008fdcd19",
  "channel": [
    12,
    13
  ],
  "startDate": "2021-06-14T16:53:56.020Z",
  "endDate": "2021-06-14T16:53:56.020Z",
  "group": [
    "60c7894b25c05d00087e882c"
  ],
  "imageSetOnAttributes": [
    "http://example.com/virpilalphal.jpg"
  ],
  "isDefault": true,
  "isActive": true,
  "isSoftDeleted": false,
  "title": "Oval shaped table",
  "itemFamily": {
    "id": "60c789973af6bf0009c023df",
    "name": "Shoes"
  },
  "sku": "Ovaltable101",
  "description": "Oval shaped table used as home furniture",
  "state": "READY",
  "itemId": 1000000269,
  "images": [
    {
      "id": "5fd7577251a93f0007e48383",
      "order": 0,
      "label": "https://abchome-xpm-images.s3.amazonaws.com/12.01.20+Giving+Tuesday/Homepage/HP_HolidaySix_GI_1.jpg?w=1067",
      "source": [
        {
          "id": "5fd7577251a93f0007e48383",
          "url": "https://abchome-xpm-images.s3.amazonaws.com/12.01.20+Giving+Tuesday/Homepage/HP_HolidaySix_GI_1.jpg?w=1067"
        }
      ]
    }
  ],
  "attributes": [
    {
      "attributeGroupId": "5fd7577251a93f0007e48383",
      "value": "size",
      "isDefault": true,
      "id": 100034567
    }
  ],
  "variants": [
    "VARIANT-01",
    "VARIANT-55"
  ],
  "createdAt": "2021-06-14T16:54:39.461Z",
  "updatedAt": "2021-06-14T16:54:39.461Z",
  "items": [
    {
      "_id": "cfbc28dd-26b8-40e6-9c37-f233c5a2d004"
    }
  ],
  "price": {
    "id": "5e31832ccaf608b232bb4cdrr",
    "isSoftDeleted": true,
    "itemId": 1000000269,
    "offerId": 1074,
    "createdAt": "2020-08-19T10:53:29.918Z",
    "updatedAt": "2020-08-19T10:53:29.918Z",
    "offers": [
      {
        "price": {
          "sale": 0,
          "base": 229,
          "currency": "USD"
        },
        "channel": 12,
        "startDate": "2018-10-19T16:46:45Z",
        "endDate": "2099-12-31T00:00:00Z",
        "kind": 10000001
      }
    ],
    "query": {
      "limit": 10,
      "count": 50,
      "offset": 0
    }
  },
  "priceRange": {
    "min": 35,
    "max": 12000
  },
  "livePrice": [
    {
      "price": {
        "base": 299,
        "sale": 199,
        "cost": 149,
        "currency": "USD"
      },
      "channel": 12,
      "startDate": "2099-12-31T10:51:00.000Z",
      "endDate": "2099-12-31T10:51:00.000Z",
      "kind": {
        "id": "5fe35c6244076c5ff4968917",
        "name": "Clearance",
        "channel": 12,
        "priceKindId": 12
      },
      "offerCode": 128755531,
      "range": {
        "min": 100,
        "max": 300
      }
    }
  ],
  "promoDates": {
    "startDate": "2099-12-31T10:51:00.000Z",
    "endDate": "2099-12-31T10:51:00.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Path Parameters

​
sku
string
required

SKU of the product whose details are to be retrieved. If the product has child products, details of the child products are also retrieved.

Query Parameters

​
priceListId
string

Get product by ID in a given price list. If priceListId is not provided, default priceList is selected to search the details for. If the SKUdoesn't belong to the default price list, price details are not returned.

​
limit
number
default:10

The maximum number of records per page.

Required range: x >= 1
​
offset
number
default:0

The number of records to skip before returning records. For example, when offset is 20 and limit is 10, this endpoint returns records from 21 to 30.

Required range: x >= 0

Response

200
application/json

OK

The response is of type object.

GET
/
api-offers
/
get-product
/
{sku}
curl --request GET \
  --url https://live.copilot.fabric.inc/api-offers/get-product/{sku} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'
{
  "id": "60c789cfe6e0910008fdcd19",
  "channel": [
    12,
    13
  ],
  "startDate": "2021-06-14T16:53:56.020Z",
  "endDate": "2021-06-14T16:53:56.020Z",
  "group": [
    "60c7894b25c05d00087e882c"
  ],
  "imageSetOnAttributes": [
    "http://example.com/virpilalphal.jpg"
  ],
  "isDefault": true,
  "isActive": true,
  "isSoftDeleted": false,
  "title": "Oval shaped table",
  "itemFamily": {
    "id": "60c789973af6bf0009c023df",
    "name": "Shoes"
  },
  "sku": "Ovaltable101",
  "description": "Oval shaped table used as home furniture",
  "state": "READY",
  "itemId": 1000000269,
  "images": [
    {
      "id": "5fd7577251a93f0007e48383",
      "order": 0,
      "label": "https://abchome-xpm-images.s3.amazonaws.com/12.01.20+Giving+Tuesday/Homepage/HP_HolidaySix_GI_1.jpg?w=1067",
      "source": [
        {
          "id": "5fd7577251a93f0007e48383",
          "url": "https://abchome-xpm-images.s3.amazonaws.com/12.01.20+Giving+Tuesday/Homepage/HP_HolidaySix_GI_1.jpg?w=1067"
        }
      ]
    }
  ],
  "attributes": [
    {
      "attributeGroupId": "5fd7577251a93f0007e48383",
      "value": "size",
      "isDefault": true,
      "id": 100034567
    }
  ],
  "variants": [
    "VARIANT-01",
    "VARIANT-55"
  ],
  "createdAt": "2021-06-14T16:54:39.461Z",
  "updatedAt": "2021-06-14T16:54:39.461Z",
  "items": [
    {
      "_id": "cfbc28dd-26b8-40e6-9c37-f233c5a2d004"
    }
  ],
  "price": {
    "id": "5e31832ccaf608b232bb4cdrr",
    "isSoftDeleted": true,
    "itemId": 1000000269,
    "offerId": 1074,
    "createdAt": "2020-08-19T10:53:29.918Z",
    "updatedAt": "2020-08-19T10:53:29.918Z",
    "offers": [
      {
        "price": {
          "sale": 0,
          "base": 229,
          "currency": "USD"
        },
        "channel": 12,
        "startDate": "2018-10-19T16:46:45Z",
        "endDate": "2099-12-31T00:00:00Z",
        "kind": 10000001
      }
    ],
    "query": {
      "limit": 10,
      "count": 50,
      "offset": 0
    }
  },
  "priceRange": {
    "min": 35,
    "max": 12000
  },
  "livePrice": [
    {
      "price": {
        "base": 299,
        "sale": 199,
        "cost": 149,
        "currency": "USD"
      },
      "channel": 12,
      "startDate": "2099-12-31T10:51:00.000Z",
      "endDate": "2099-12-31T10:51:00.000Z",
      "kind": {
        "id": "5fe35c6244076c5ff4968917",
        "name": "Clearance",
        "channel": 12,
        "priceKindId": 12
      },
      "offerCode": 128755531,
      "range": {
        "min": 100,
        "max": 300
      }
    }
  ],
  "promoDates": {
    "startDate": "2099-12-31T10:51:00.000Z",
    "endDate": "2099-12-31T10:51:00.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Path Parameters

​
sku
string
required

SKU of the product whose details are to be retrieved. If the product has child products, details of the child products are also retrieved.

Query Parameters

​
priceListId
string

Get product by ID in a given price list. If priceListId is not provided, default priceList is selected to search the details for. If the SKUdoesn't belong to the default price list, price details are not returned.

​
limit
number
default:10

The maximum number of records per page.

Required range: x >= 1
​
offset
number
default:0

The number of records to skip before returning records. For example, when offset is 20 and limit is 10, this endpoint returns records from 21 to 30.

Required range: x >= 0

Response

200
application/json

OK

The response is of type object.