REST API for Oracle Commerce Cloud 22A

createPurchaseList

post

/ccstore/v1/purchaseLists

Create Purchase List. This operation is used to create a purchase list for a given site, account, user context.Each purchase list should have a unique name for a given user. Dynamic Properties of purchase list and purchase list line item can be added in the the request using the key value pair structure ("dynamicPropertyKey":"dynamicPropertyValue"). These property values can take the types of boolean, date, float, string, timestamp, enumerated, big string.

Request

Supported Media Types

application/json

Root Schema : createPurchaseList_request

Type: object

Show Source

accountId(optional): string

The id of the Organization.
description(optional): string

Description for the purchase list.
dynamicProperty(optional): object dynamicProperty

The value of the dynamic Property
items(optional): array items

list of purchase list items
name: string

The name of the purchase list.
siteId(optional): string

The Id of the site.

{
    "properties":{
        "dynamicProperty":{
            "description":"The value of the dynamic Property",
            "type":"object"
        },
        "accountId":{
            "description":"The id of the Organization.",
            "type":"string"
        },
        "name":{
            "description":"The name of the purchase list.",
            "type":"string"
        },
        "description":{
            "description":"Description for the purchase list.",
            "type":"string"
        },
        "siteId":{
            "description":"The Id of the site.",
            "type":"string"
        },
        "items":{
            "description":"list of purchase list items",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "dynamicProperty":{
                        "description":"The value of the dynamic Property",
                        "type":"object"
                    },
                    "productId":{
                        "description":"The product id",
                        "type":"string"
                    },
                    "quantityDesired":{
                        "description":"Quantity desired for the item",
                        "type":"integer"
                    },
                    "catRefId":{
                        "description":"catalog ref id ",
                        "type":"string"
                    }
                },
                "required":[
                    "catRefId",
                    "quantityDesired",
                    "productId"
                ]
            }
        }
    },
    "required":[
        "name"
    ],
    "example":{
        "dynamicProperty":"dynamicProperty value",
        "accountId":"or-100001",
        "name":"Purchase List 1",
        "description":"Purchase List",
        "siteId":"siteUS",
        "items":[
            {
                "dynamicProperty":"dynamicProperty value",
                "productId":"Product_18Cxi",
                "quantityDesired":25,
                "catRefId":"Sku_18Dxi"
            },
            {
                "dynamicProperty":"dynamicProperty value",
                "productId":"Product_5Cx",
                "quantityDesired":30,
                "catRefId":"Sku_5Cxy"
            }
        ]
    }
}

Example:

{
    "dynamicProperty":"dynamicProperty value",
    "accountId":"or-100001",
    "name":"Purchase List 1",
    "description":"Purchase List",
    "siteId":"siteUS",
    "items":[
        {
            "dynamicProperty":"dynamicProperty value",
            "productId":"Product_18Cxi",
            "quantityDesired":25,
            "catRefId":"Sku_18Dxi"
        },
        {
            "dynamicProperty":"dynamicProperty value",
            "productId":"Product_5Cx",
            "quantityDesired":30,
            "catRefId":"Sku_5Cxy"
        }
    ]
}

Nested Schema : dynamicProperty

Type: object

The value of the dynamic Property

Nested Schema : items

Type: array

list of purchase list items

Show Source

Array of: object items

{
    "description":"list of purchase list items",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "dynamicProperty":{
                "description":"The value of the dynamic Property",
                "type":"object"
            },
            "productId":{
                "description":"The product id",
                "type":"string"
            },
            "quantityDesired":{
                "description":"Quantity desired for the item",
                "type":"integer"
            },
            "catRefId":{
                "description":"catalog ref id ",
                "type":"string"
            }
        },
        "required":[
            "catRefId",
            "quantityDesired",
            "productId"
        ]
    }
}

Nested Schema : items

Type: object

Show Source

catRefId: string

catalog ref id
dynamicProperty(optional): object dynamicProperty

The value of the dynamic Property
productId: string

The product id
quantityDesired: integer

Quantity desired for the item

{
    "type":"object",
    "properties":{
        "dynamicProperty":{
            "description":"The value of the dynamic Property",
            "type":"object"
        },
        "productId":{
            "description":"The product id",
            "type":"string"
        },
        "quantityDesired":{
            "description":"Quantity desired for the item",
            "type":"integer"
        },
        "catRefId":{
            "description":"catalog ref id ",
            "type":"string"
        }
    },
    "required":[
        "catRefId",
        "quantityDesired",
        "productId"
    ]
}

Nested Schema : dynamicProperty

Type: object

The value of the dynamic Property

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : createPurchaseList_response

Type: object

Show Source

accountId(optional): string

The id of the Organization.
creationDate(optional): string

The date when purchase list is created.
description(optional): string

Description for the purchase list.
dynamicProperty(optional): object dynamicProperty

The value of the dynamic Property
id(optional): string

The Id of the purchase list.
items(optional): array items

list of purchase list items
lastModifiedBy(optional): object lastModifiedBy

The user who last modified this purchase list.
lastModifiedDate(optional): string

The last modified date for the purchase list.
name(optional): string

The name of the purchase list.
owner(optional): object owner

The user who created this purchase list.
repositoryId(optional): string

Repository Id of the purchase list.
sharedWithOthers(optional): boolean

Flag to show if the purchase list is shared with other shoppers or not.
siteId(optional): string

The Id of the site.

{
    "properties":{
        "owner":{
            "description":"The user who created this purchase list.",
            "type":"object",
            "properties":{
                "firstName":{
                    "description":"The first name of the user",
                    "type":"string"
                },
                "lastName":{
                    "description":"The last name of the user",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"respository Id of the user",
                    "type":"string"
                },
                "email":{
                    "description":"The email id of the user",
                    "type":"string"
                }
            }
        },
        "lastModifiedDate":{
            "description":"The last modified date for the purchase list.",
            "type":"string"
        },
        "lastModifiedBy":{
            "description":"The user who last modified this purchase list.",
            "type":"object",
            "properties":{
                "firstName":{
                    "description":"The first name of the user",
                    "type":"string"
                },
                "lastName":{
                    "description":"The last name of the user",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"respository Id of the user",
                    "type":"string"
                },
                "email":{
                    "description":"The email id of the user",
                    "type":"string"
                }
            }
        },
        "description":{
            "description":"Description for the purchase list.",
            "type":"string"
        },
        "creationDate":{
            "description":"The date when purchase list is created.",
            "type":"string"
        },
        "dynamicProperty":{
            "description":"The value of the dynamic Property",
            "type":"object"
        },
        "accountId":{
            "description":"The id of the Organization.",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository Id of the purchase list.",
            "type":"string"
        },
        "name":{
            "description":"The name of the purchase list.",
            "type":"string"
        },
        "siteId":{
            "description":"The Id of the site.",
            "type":"string"
        },
        "id":{
            "description":"The Id of the purchase list.",
            "type":"string"
        },
        "items":{
            "description":"list of purchase list items",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "dynamicProperty":{
                        "description":"The value of the dynamic Property",
                        "type":"object"
                    },
                    "productId":{
                        "description":"The product id",
                        "type":"string"
                    },
                    "quantityDesired":{
                        "description":"Quantity desired for the item",
                        "type":"integer"
                    },
                    "repositoryId":{
                        "description":"repository id of purchase list item",
                        "type":"boolean"
                    },
                    "id":{
                        "description":"Id of the purchase list item",
                        "type":"string"
                    },
                    "catRefId":{
                        "description":"catalog ref id ",
                        "type":"string"
                    }
                }
            }
        },
        "sharedWithOthers":{
            "description":"Flag to show if the purchase list is shared with other shoppers or not.",
            "type":"boolean"
        }
    }
}

Nested Schema : dynamicProperty

Type: object

The value of the dynamic Property

Nested Schema : items

Type: array

list of purchase list items

Show Source

Array of: object items

{
    "description":"list of purchase list items",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "dynamicProperty":{
                "description":"The value of the dynamic Property",
                "type":"object"
            },
            "productId":{
                "description":"The product id",
                "type":"string"
            },
            "quantityDesired":{
                "description":"Quantity desired for the item",
                "type":"integer"
            },
            "repositoryId":{
                "description":"repository id of purchase list item",
                "type":"boolean"
            },
            "id":{
                "description":"Id of the purchase list item",
                "type":"string"
            },
            "catRefId":{
                "description":"catalog ref id ",
                "type":"string"
            }
        }
    }
}

Nested Schema : lastModifiedBy

Type: object

The user who last modified this purchase list.

Show Source

email(optional): string

The email id of the user
firstName(optional): string

The first name of the user
lastName(optional): string

The last name of the user
repositoryId(optional): string

respository Id of the user

{
    "description":"The user who last modified this purchase list.",
    "type":"object",
    "properties":{
        "firstName":{
            "description":"The first name of the user",
            "type":"string"
        },
        "lastName":{
            "description":"The last name of the user",
            "type":"string"
        },
        "repositoryId":{
            "description":"respository Id of the user",
            "type":"string"
        },
        "email":{
            "description":"The email id of the user",
            "type":"string"
        }
    }
}

Nested Schema : owner

Type: object

The user who created this purchase list.

Show Source

email(optional): string

The email id of the user
firstName(optional): string

The first name of the user
lastName(optional): string

The last name of the user
repositoryId(optional): string

respository Id of the user

{
    "description":"The user who created this purchase list.",
    "type":"object",
    "properties":{
        "firstName":{
            "description":"The first name of the user",
            "type":"string"
        },
        "lastName":{
            "description":"The last name of the user",
            "type":"string"
        },
        "repositoryId":{
            "description":"respository Id of the user",
            "type":"string"
        },
        "email":{
            "description":"The email id of the user",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

catRefId(optional): string

catalog ref id
dynamicProperty(optional): object dynamicProperty

The value of the dynamic Property
id(optional): string

Id of the purchase list item
productId(optional): string

The product id
quantityDesired(optional): integer

Quantity desired for the item
repositoryId(optional): boolean

repository id of purchase list item

{
    "type":"object",
    "properties":{
        "dynamicProperty":{
            "description":"The value of the dynamic Property",
            "type":"object"
        },
        "productId":{
            "description":"The product id",
            "type":"string"
        },
        "quantityDesired":{
            "description":"Quantity desired for the item",
            "type":"integer"
        },
        "repositoryId":{
            "description":"repository id of purchase list item",
            "type":"boolean"
        },
        "id":{
            "description":"Id of the purchase list item",
            "type":"string"
        },
        "catRefId":{
            "description":"catalog ref id ",
            "type":"string"
        }
    }
}

Nested Schema : dynamicProperty

Type: object

The value of the dynamic Property

Example Response (application/json)

{
    "owner":{
        "lastName":"Anderson",
        "firstName":"Kim",
        "repositoryId":"se-570031",
        "id":"se-570031",
        "email":"kim@example.com"
    },
    "lastModifiedDate":"2017-09-27T09:48:22.000Z",
    "lastModifiedBy":{
        "lastName":"Anderson",
        "firstName":"Kim",
        "repositoryId":"se-570031",
        "id":"se-570031",
        "email":"kim@example.com"
    },
    "sharedWithOther":false,
    "description":"Purchase List",
    "creationDate":"2017-09-27T09:48:22.000Z",
    "dynamicProperty":"dynamicProperty value",
    "accountId":"or-100001",
    "repositoryId":"gl30074",
    "name":"Purchase List 1",
    "siteId":"siteUS",
    "id":"gl30074",
    "items":[
        {
            "dynamicProperty":"dynamicProperty value",
            "productId":"Product_18Cxi",
            "quantityDesired":25,
            "repositoryId":"gi10001",
            "id":"gi10001",
            "catRefId":"Sku_18Dxi"
        },
        {
            "dynamicProperty":"dynamicProperty value",
            "productId":"Product_5Cx",
            "quantityDesired":30,
            "repositoryId":"gi10002",
            "id":"gi10002",
            "catRefId":"Sku_5Cxy"
        }
    ],
    "purchaseListItems":1
}

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| |------------------|------------------| |64101|Error while creating a purchase List| |64100|Invalid profile or user logged out

Root Schema : errorModel

Type: object

Show Source

devMessage(optional): string

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

The numerical code identifying the error
errors(optional): array errors

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

The localized message describing the error
moreInfo(optional): string

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

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

The HTTP status code
type(optional): string

The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

devMessage(optional): string

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

The numerical code identifying the error
message(optional): string

The localized message describing the error
moreInfo(optional): string

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

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

The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}