REST API for Oracle Commerce Cloud December 2017

getPurchaseList

get

/ccstore/v1/purchaseLists/{id}

Get Purchase List. This operation is used to get the Purchase list information of a from Oracle Commerce Cloud.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

The ID of the requested Purchase list.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getPurchaseList_response

Properties

accountId: Type: string

The id of the Organization.
creationDate: Type: string

The date when purchase list is created.
description: Type: string

Description for the purchase list.
id: Type: string

The Id of the purchase list.
items: Type: array items

Additional Properties Allowed:

list of purchase list items
lastModifiedDate: Type: string

The last modified date for the purchase list.
name: Type: string

The name of the purchase list.
owner: Type: object owner

Additional Properties Allowed:

The user who created this purchase list.
repositoryId: Type: string

Repository Id of the purchase list.
siteId: Type: string

The Id of the site.

Nested Schema : items

Type: array

list of purchase list items

Items

Type: object items

Additional Properties Allowed:

Nested Schema : owner

Type: object

The user who created this purchase list.

Properties

firstName: Type: string

The first name of the user
lastName: Type: string

The last name of the user
repositoryId: Type: string

respository Id of the user

Nested Schema : items

Type: object

Properties

catRefId: Type: string

catalog ref id
id: Type: string

Id of the purchase list item
productId: Type: string

The product id
quantityDesired: Type: integer

Quantity desired for the item
repositoryId: Type: boolean

repository id of purchase list item

Example application/json


{
    "owner":{
        "lastName":"Anderson",
        "firstName":"Kim",
        "repositoryId":"se-570031",
        "id":"se-570031"
    },
    "accountId":null,
    "lastModifiedDate":"2017-09-27T09:48:22.000Z",
    "repositoryId":"gl30074",
    "name":"Purchase List 2",
    "description":"Purchase List update",
    "siteId":null,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccstoreui/v1/purchaseLists/gl30074"
        }
    ],
    "id":"gl30074",
    "creationDate":"2017-09-27T09:48:22.000Z",
    "items":[
        {
            "productId":"Product_5Cx",
            "quantityDesired":30,
            "repositoryId":"gi10001",
            "id":"gi10001",
            "catRefId":"Sku_5Cxy"
        }
    ]
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |64102|Error while fetching the purchase list| |64100|Invalid profile id|

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "owner": {
    "lastName": "Anderson",
    "firstName": "Kim",
    "repositoryId": "se-570031",
    "id": "se-570031"
  },
  "accountId": null,
  "lastModifiedDate": "2017-09-27T09:48:22.000Z",
  "repositoryId": "gl30074",
  "name": "Purchase List 2",
  "description": "Purchase List update",
  "siteId": null,
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccstoreui/v1/purchaseLists/gl30074"
  }],
  "id": "gl30074",
  "creationDate": "2017-09-27T09:48:22.000Z",
  "items": [{
    "productId": "Product_5Cx",
    "quantityDesired": 30,
    "repositoryId": "gi10001",
    "id": "gi10001",
    "catRefId": "Sku_5Cxy"
  }]
}