Shop Articles API

Bu içerik henüz dilinizde mevcut değil.

List shop articles
Get a single shop article
Create a shop article
Update a shop article
Fields

List shop articles

List all shop articles for an account:

GET /shop_articles

Response

Status: 200 OK

[
  {
    "created_at": "2022-11-24T08:11:21-06:00",
    "id": 2,
    "name": "Dell Precision M4400",
    "reference": "dell_m4400",
    "sourceID": null,
    "updated_at": "2022-11-24T08:11:21-06:00",
    "nodeID": "..."
  },
  {
    "created_at": "2022-11-24T08:11:21-06:00",
    "id": 3,
    "name": "Dell Precision T5400 Workstation",
    "reference": "dell_t5400",
    "sourceID": null,
    "updated_at": "2022-11-24T08:11:21-06:00",
    "nodeID": "..."
  },
  "..."
]

The response contains these fields by default. Filtering and pagination are available to reduce/limit the collection of shop articles.

Predefined Filters

The following predefined filters are available:

/shop_articles/enabled : List all shop articles that are enabled
/shop_articles/disabled : List all shop articles that are disabled
/shop_articles/on_offer : List all shop articles with the information (name, pricing, etc.) as it is on offer in the shop

Collection Fields

By default the following fields will appear in collections of shop articles:

id , sourceID , reference , name , created_at , updated_at

Obtain a different set of fields using the ?fields= parameter .

Filtering

Filtering is available for the following fields :

id , source , sourceID , reference , name , disabled , created_at , updated_at

Sorting

By default a collection of shop articles is sorted ascending by name .

The following fields are accepted by the ?sort= parameter :

id , sourceID , reference , name , created_at , updated_at

Get a single shop article

GET /shop_articles/:id

Response

Status: 200 OK

{
  "calendar": {
    "id": 50,
    "name": "24x7 (Monday through Sunday)",
    "nodeID": "..."
  },
  "category": {
    "id": 5,
    "name": "Laptops",
    "localized_name": "Laptops",
    "nodeID": "..."
  },
  "created_at": "2022-11-24T08:11:21-06:00",
  "delivery_duration": 8640,
  "disabled": false,
  "end_at": null,
  "fulfillment_template": {
    "id": 1401,
    "subject": "Deliver Shop Article",
    "localized_subject": "Deliver Shop Article",
    "nodeID": "..."
  },
  "full_description": "Dell’s most powerful 17\" mobile workstation with AI. Featuring up to Intel® Core® or Xeon® processors, NVIDIA® professional graphics and Dell Optimizer for Precision.",
  "id": 2,
  "max_quantity": 1,
  "name": "Dell Precision M4400",
  "picture_uri": "https://R-Service-demo-assets.s3-accelerate.dualstack.amazonaws.com/avatars/shop_article_accounts/large/Dell Precision M4400 Laptop PC.png",
  "price": "2350.0",
  "price_currency": "usd",
  "product": {
    "id": 47,
    "name": "Dell Precision M4400 Laptop PC",
    "category": "computer/laptop_pc",
    "nodeID": "...",
    "brand": "Dell EMC",
    "model": "Precision M4400"
  },
  "recurring_period": null,
  "recurring_price": null,
  "recurring_price_currency": null,
  "reference": "DellM4400",
  "requires_shipping": true,
  "short_description": "Dell’s most powerful 17\" mobile workstation with AI.",
  "source": null,
  "sourceID": null,
  "start_at": null,
  "time_zone": "Central Time (US & Canada)",
  "ui_extension": null,
  "updated_at": "2022-11-24T08:11:21-06:00",
  "localized_full_description": "Dell’s most powerful 17\" mobile workstation with AI. Featuring up to Intel® Core® or Xeon® processors, NVIDIA® professional graphics and Dell Optimizer for Precision.",
  "localized_name": "Dell Precision M4400",
  "localized_short_description": "Dell’s most powerful 17\" mobile workstation with AI.",
  "nodeID": "...",
  "translation_id": 2
}

The response contains these fields .

Create a shop article

POST /shop_articles

When creating a new shop article these fields are available.

Response

Status: 201 Created

{
  "created_at": "...",
  "...": "..."
}

The response contains all fields of the created shop article and is similar to the response in Get a single shop article

Update a shop article

PATCH /shop_articles/:id

When updating a shop article these fields are available.

Response

Status: 200 OK

{
  "created_at": "...",
  "...": "..."
}

The response contains all fields of the updated shop article and is similar to the response in Get a single shop article

Fields

calendar

Required reference to Calendar — The Calendar field is used to select the Calendar that defines the work hours related to the fulfillment/delivery.