{ "paths":{ "/ccagent/v1/registry":{ "get":{ "summary":"getRegistry", "produces":[ "application/json" ], "operationId":"getRegistry", "description":"Get Registry. Get the endpoint registry.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getRegistry_response" }, "examples":{ "application/json":{ "httpPort":9080, "endpointMap":{ "getEndpointAPIs":{ "responseType":"application/json", "authRequired":false, "requestType":null, "method":"GET", "hasDoc":true, "url":"/ccagent/v1/api", "httpsRequired":false }, "getProfile":{ "responseType":"application/json", "authRequired":true, "requestType":null, "method":"GET", "hasDoc":false, "url":"/ccagent/v1/profiles/{}", "httpsRequired":false } }, "httpsPort":9443, "crossDomainRequestsEnabled":false } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response" } }, "tags":[ "Agent/OAuth" ], "x-internal-id":"ccagent-v1-registry-get", "x-filename-id":"ccagent-v1-registry-get" } }, "/ccagent/v1/organizationRequests/{id}":{ "get":{ "summary":"getOrganizationRequests", "produces":[ "application/json" ], "operationId":"getOrganizationRequests", "description":"Get Organization Request. This operation is used to get the Organization request information of a customer from Oracle Commerce Cloud.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getOrganizationRequests_response" }, "examples":{ "application/json":{ "approverComments":"Request is approved", "requesterOrganization":null, "profile":{ "id":"100001" }, "organization":{ "id":"150002" }, "name":"My account", "siteId":"siteUS", "id":100001, "requesterComments":"None", "parentOrgName":"Oracle Global", "status":"approved" } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|100000|If input passed is invalid|\n|101001|If there was no organization request found with the given id." } }, "parameters":[ { "in":"path", "name":"id", "description":"The ID of the requested Organization Request", "type":"string", "required":true }, { "in":"query", "name":"expand", "description":"Expand query param : currently used to expand profile, organization and orgAddress Info.(Allowed Values: profile - profile static data, profileAll - profile static & dynamic data, organization - organization static data, organizationAll - organization static & dynamic data, requestAll - organizationRequest static & dynamic data, organizationAddresses).", "type":"string", "required":false } ], "tags":[ "Agent/Organization Request" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-organizationRequests-{id}-get", "x-filename-id":"ccagent-v1-organizationrequests-id-get" } }, "/ccagent/v1/payment/auth":{ "post":{ "summary":"authPayment", "produces":[ "application/json" ], "operationId":"authPayment", "description":"Auth Payment. Payment authorization endpoint.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/authPayment_response" }, "examples":{ "application/json":{ "ignore_avs":false, "partner_solution_id":"ABCDXYZ", "signature":"0O5+qVCnDZ+B9jBJwcYqbhg/8dgW/dDKP7LCH5LQq9o=", "sopURL":"https://testsecureacceptance.cybersource.com/silent/pay", "profile_id":"Test111", "access_key":"a7b7592b38603ae99b2815712007dd8b", "transaction_uuid":"deec2cf1467542f8a9b6b8928f31f8be", "signed_date_time":"2014-10-27T06:27:11Z" } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response" } }, "parameters":[ { "schema":{ "$ref":"#/definitions/authPayment_request" }, "in":"body", "name":"authPayment_request" } ], "tags":[ "Agent/Payment" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-payment-auth-post", "x-filename-id":"ccagent-v1-payment-auth-post" } }, "/ccagent/v1/orders/getGiftWithPurchaseChoices":{ "get":{ "summary":"getGiftWithPurchaseChoices", "produces":[ "application/json" ], "operationId":"getGiftWithPurchaseChoices", "description":"Get Gift With Purchase Choices. Get all of the products and skus available for selection for a gift with purchase gift. Additonally takes x-ccsite header to retrieve the promotions based on the site. If the site is not passed then the default site is considered. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value. If this header is not provided, then the endPoint will consider first active organization as the current organization for a B2B user.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getGiftWithPurchaseChoices_response" }, "examples":{ "application/json":{ "product":{ "listVolumePrice":null, "relatedProducts":null, "orderLimit":null, "CountryOfOrigin":"US", "listPrices":null, "type":"camcorder", "largeImageURLs":[ "/ccstore/v1/images/?source=/file/v7023553219093550939/products/Samsung_F90BN_LARGE.jpg&height=940&width=940" ], "listVolumePrices":null, "primaryImageAltText":"Samsung - F90BN HD Flash Memory Camcorder", "FilterDiameter":null, "id":"camcorder_1", "brand":null, "parentCategories":[ { "repositoryId":"cameracat", "fixedParentCategories":[ { "repositoryId":"rootCategory", "fixedParentCategories":[ ] } ] } ], "height":null, "OperatingTemperatures":null, "defaultProductListingSku":null, "assetable":false, "unitOfMeasure":null, "primaryMediumImageURL":"/ccstore/v1/images/?source=/file/v7023553219093550939/products/Samsung_F90BN_LARGE.jpg&height=475&width=475", "seoUrlSlugDerived":"Samsung - F90BN HD Flash Memory Camcorder", "weight":null, "active":true, "thumbImageURLs":[ "/ccstore/v1/images/?source=/file/v7023553219093550939/products/Samsung_F90BN_LARGE.jpg&height=100&width=100" ], "route":"/samsung-f90bn-hd-flash-memory-camcorder/product/camcorder_1", "relatedArticles":[ ], "mediumImageURLs":[ "/ccstore/v1/images/?source=/file/v7023553219093550939/products/Samsung_F90BN_LARGE.jpg&height=475&width=475" ], "primarySourceImageURL":"/ccstore/v1/images/?source=/file/v7023553219093550939/products/Samsung_F90BN_LARGE.jpg&height=300&width=300", "parentCategory":null, "sourceImageURLs":[ "/ccstore/v1/images/?source=/file/v7023553219093550939/products/Samsung_F90BN_LARGE.jpg&height=300&width=300" ], "primarySmallImageURL":"/ccstore/v1/images/?source=/file/v7023553219093550939/products/Samsung_F90BN_LARGE.jpg&height=300&width=300", "minOrderLimit":1, "avgCustRating":null, "longDescription":"Record footage in 720p resolution with this Samsung F980BN\n HMX-F90BN/XAA flash memory camcorder, which features a CMOS sensor to help you capture high-definition\n videos. The 2. LCD display provides a clear view for shooting or reviewing images.\n ", "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v7023553219093550939/products/Samsung_F90BN_LARGE.jpg&height=100&width=100", "ManualAutofocus":null, "displayName":"Samsung - F90BN HD Flash Memory Camcorder", "description":null, "salePrices":null, "primaryFullImageURL":"/ccstore/v1/images/?source=/file/v7023553219093550939/products/Samsung_F90BN_LARGE.jpg", "parentCategoriesAncestorCategories":[ { "repositoryId":"rootCategory", "fixedParentCategories":[ ] } ], "productVariantOptions":[ { "optionValueMap":{ "Silver":1, "Neon":2, "Black":0 }, "optionId":"color", "mapKeyPropertyAttribute":"sku-camcorder_color", "optionName":"color" }, { "optionValueMap":{ "27x optical/320x digital":4, "20x optical/320x digital":3, "2x optical/130x digital":0 }, "optionId":"zoom", "mapKeyPropertyAttribute":"sku-camcorder_zoom", "optionName":"zoom" } ], "zoomDisplay":null, "primaryLargeImageURL":"/ccstore/v1/images/?source=/file/v7023553219093550939/products/Samsung_F90BN_LARGE.jpg&height=940&width=940", "smallImageURLs":[ "/ccstore/v1/images/?source=/file/v7023553219093550939/products/Samsung_F90BN_LARGE.jpg&height=300&width=300" ], "shippingSurcharges":null, "filteredSKUs":[ { "productFamily":null, "dynamicPropertyMapLong":{ "sku-camcorder_zoom":0, "sku-camcorder_color":1 }, "primaryThumbImageURL":null, "largeImage":null, "smallImage":null, "color":"Silver", "listVolumePrice":null, "salePrices":null, "primaryFullImageURL":null, "listPrices":null, "productListingSku":null, "largeImageURLs":[ ], "productLine":null, "listVolumePrices":null, "primaryLargeImageURL":null, "smallImageURLs":[ ], "model":null, "id":"camcordersku_1_1", "thumbnailImage":null, "barcode":"200000000516", "saleVolumePrices":null, "salePriceEndDate":null, "saleVolumePrice":null, "salePriceStartDate":null, "images":[ ], "quantity":null, "unitOfMeasure":null, "salePrice":null, "primaryMediumImageURL":null, "fullImageURLs":[ ], "dynamicPropertyMapBigString":{ }, "active":true, "zoom":"2x optical/130x digital", "thumbImageURLs":[ ], "variantValuesOrder":{ }, "mediumImageURLs":[ ], "repositoryId":"camcordersku_1_1", "primarySourceImageURL":null, "primarySmallImageURL":null, "sourceImageURLs":[ ], "listPrice":null, "configurable":false }, { "productFamily":null, "dynamicPropertyMapLong":{ "sku-camcorder_zoom":3, "sku-camcorder_color":0 }, "primaryThumbImageURL":null, "largeImage":null, "smallImage":null, "color":"Black", "listVolumePrice":null, "salePrices":null, "primaryFullImageURL":null, "listPrices":null, "productListingSku":null, "largeImageURLs":[ ], "productLine":null, "listVolumePrices":null, "primaryLargeImageURL":null, "smallImageURLs":[ ], "model":null, "id":"camcordersku_1_2", "thumbnailImage":null, "barcode":"200000000523", "saleVolumePrices":null, "salePriceEndDate":null, "saleVolumePrice":null, "salePriceStartDate":null, "images":[ ], "quantity":null, "unitOfMeasure":null, "salePrice":null, "primaryMediumImageURL":null, "fullImageURLs":[ ], "dynamicPropertyMapBigString":{ }, "active":true, "zoom":"20x optical/320x digital", "thumbImageURLs":[ ], "variantValuesOrder":{ }, "mediumImageURLs":[ ], "repositoryId":"camcordersku_1_2", "primarySourceImageURL":null, "primarySmallImageURL":null, "sourceImageURLs":[ ], "listPrice":null, "configurable":false }, { "productFamily":null, "dynamicPropertyMapLong":{ "sku-camcorder_zoom":0, "sku-camcorder_color":2 }, "primaryThumbImageURL":null, "largeImage":null, "smallImage":null, "color":"Neon", "listVolumePrice":null, "salePrices":null, "primaryFullImageURL":null, "listPrices":null, "productListingSku":null, "largeImageURLs":[ ], "productLine":null, "listVolumePrices":null, "primaryLargeImageURL":null, "smallImageURLs":[ ], "model":null, "id":"camcordersku_1_3", "thumbnailImage":null, "barcode":"200000000530", "saleVolumePrices":null, "salePriceEndDate":null, "saleVolumePrice":null, "salePriceStartDate":null, "images":[ ], "quantity":null, "unitOfMeasure":null, "salePrice":null, "primaryMediumImageURL":null, "fullImageURLs":[ ], "dynamicPropertyMapBigString":{ }, "active":true, "zoom":"2x optical/130x digital", "thumbImageURLs":[ ], "variantValuesOrder":{ }, "mediumImageURLs":[ ], "repositoryId":"camcordersku_1_3", "primarySourceImageURL":null, "primarySmallImageURL":null, "sourceImageURLs":[ ], "listPrice":null, "configurable":false }, { "productFamily":null, "dynamicPropertyMapLong":{ "sku-camcorder_zoom":4 }, "primaryThumbImageURL":null, "largeImage":null, "smallImage":null, "color":null, "listVolumePrice":null, "salePrices":null, "primaryFullImageURL":null, "listPrices":null, "productListingSku":null, "largeImageURLs":[ ], "productLine":null, "listVolumePrices":null, "primaryLargeImageURL":null, "smallImageURLs":[ ], "model":null, "id":"camcordersku_1_4", "thumbnailImage":null, "barcode":"200000000547", "saleVolumePrices":null, "salePriceEndDate":null, "saleVolumePrice":null, "salePriceStartDate":null, "images":[ ], "quantity":null, "unitOfMeasure":null, "salePrice":null, "primaryMediumImageURL":null, "fullImageURLs":[ ], "dynamicPropertyMapBigString":{ }, "active":true, "zoom":"27x optical/320x digital", "thumbImageURLs":[ ], "variantValuesOrder":{ }, "mediumImageURLs":[ ], "repositoryId":"camcordersku_1_4", "primarySourceImageURL":null, "primarySmallImageURL":null, "sourceImageURLs":[ ], "listPrice":null, "configurable":false } ], "saleVolumePrices":null, "primaryImageTitle":"Samsung - F90BN HD Flash Memory Camcorder", "saleVolumePrice":null, "childSKUs":[ { "productFamily":null, "dynamicPropertyMapLong":{ "sku-camcorder_zoom":0, "sku-camcorder_color":1 }, "primaryThumbImageURL":null, "largeImage":null, "smallImage":null, "color":"Silver", "listVolumePrice":null, "salePrices":null, "primaryFullImageURL":null, "listPrices":null, "productListingSku":null, "largeImageURLs":[ ], "productLine":null, "listVolumePrices":null, "primaryLargeImageURL":null, "smallImageURLs":[ ], "model":null, "id":"camcordersku_1_1", "thumbnailImage":null, "barcode":"200000000516", "saleVolumePrices":null, "salePriceEndDate":null, "saleVolumePrice":null, "salePriceStartDate":null, "images":[ ], "quantity":null, "unitOfMeasure":null, "salePrice":null, "primaryMediumImageURL":null, "fullImageURLs":[ ], "dynamicPropertyMapBigString":{ }, "active":true, "zoom":"2x optical/130x digital", "thumbImageURLs":[ ], "mediumImageURLs":[ ], "repositoryId":"camcordersku_1_1", "primarySourceImageURL":null, "primarySmallImageURL":null, "sourceImageURLs":[ ], "listPrice":null, "configurable":false }, { "productFamily":null, "dynamicPropertyMapLong":{ "sku-camcorder_zoom":3, "sku-camcorder_color":0 }, "primaryThumbImageURL":null, "largeImage":null, "smallImage":null, "color":"Black", "listVolumePrice":null, "salePrices":null, "primaryFullImageURL":null, "listPrices":null, "productListingSku":null, "largeImageURLs":[ ], "productLine":null, "listVolumePrices":null, "primaryLargeImageURL":null, "smallImageURLs":[ ], "model":null, "id":"camcordersku_1_2", "thumbnailImage":null, "barcode":"200000000523", "saleVolumePrices":null, "salePriceEndDate":null, "saleVolumePrice":null, "salePriceStartDate":null, "images":[ ], "quantity":null, "unitOfMeasure":null, "salePrice":null, "primaryMediumImageURL":null, "fullImageURLs":[ ], "dynamicPropertyMapBigString":{ }, "active":true, "zoom":"20x optical/320x digital", "thumbImageURLs":[ ], "mediumImageURLs":[ ], "repositoryId":"camcordersku_1_2", "primarySourceImageURL":null, "primarySmallImageURL":null, "sourceImageURLs":[ ], "listPrice":null, "configurable":false }, { "productFamily":null, "dynamicPropertyMapLong":{ "sku-camcorder_zoom":0, "sku-camcorder_color":2 }, "primaryThumbImageURL":null, "largeImage":null, "smallImage":null, "color":"Neon", "listVolumePrice":null, "salePrices":null, "primaryFullImageURL":null, "listPrices":null, "productListingSku":null, "largeImageURLs":[ ], "productLine":null, "listVolumePrices":null, "primaryLargeImageURL":null, "smallImageURLs":[ ], "model":null, "id":"camcordersku_1_3", "thumbnailImage":null, "barcode":"200000000530", "saleVolumePrices":null, "salePriceEndDate":null, "saleVolumePrice":null, "salePriceStartDate":null, "images":[ ], "quantity":null, "unitOfMeasure":null, "salePrice":null, "primaryMediumImageURL":null, "fullImageURLs":[ ], "dynamicPropertyMapBigString":{ }, "active":true, "zoom":"2x optical/130x digital", "thumbImageURLs":[ ], "mediumImageURLs":[ ], "repositoryId":"camcordersku_1_3", "primarySourceImageURL":null, "primarySmallImageURL":null, "sourceImageURLs":[ ], "listPrice":null, "configurable":false }, { "productFamily":null, "dynamicPropertyMapLong":{ "sku-camcorder_zoom":4 }, "primaryThumbImageURL":null, "largeImage":null, "smallImage":null, "color":null, "listVolumePrice":null, "salePrices":null, "primaryFullImageURL":null, "listPrices":null, "productListingSku":null, "largeImageURLs":[ ], "productLine":null, "listVolumePrices":null, "primaryLargeImageURL":null, "smallImageURLs":[ ], "model":null, "id":"camcordersku_1_4", "thumbnailImage":null, "barcode":"200000000547", "saleVolumePrices":null, "salePriceEndDate":null, "saleVolumePrice":null, "salePriceStartDate":null, "images":[ ], "quantity":null, "unitOfMeasure":null, "salePrice":null, "primaryMediumImageURL":null, "fullImageURLs":[ ], "dynamicPropertyMapBigString":{ }, "active":true, "zoom":"27x optical/320x digital", "thumbImageURLs":[ ], "mediumImageURLs":[ ], "repositoryId":"camcordersku_1_4", "primarySourceImageURL":null, "primarySmallImageURL":null, "sourceImageURLs":[ ], "listPrice":null, "configurable":false } ], "relatedMediaContent":[ ], "salePrice":null, "fullImageURLs":[ "/ccstore/v1/images/?source=/file/v7023553219093550939/products/Samsung_F90BN_LARGE.jpg" ], "length":null, "variantValuesOrder":{ }, "notForIndividualSale":false, "repositoryId":"camcorder_1", "width":null, "shippingSurcharge":null, "fractionalQuantitiesAllowed":false, "productImagesMetadata":[ { } ], "configurable":false, "ancestorCategoriesForFullDeploy":[ ], "listPrice":null }, "skus":[ { "productFamily":null, "dynamicPropertyMapLong":{ "sku-camcorder_zoom":0, "sku-camcorder_color":1 }, "primaryThumbImageURL":null, "largeImage":null, "smallImage":null, "color":"Silver", "listVolumePrice":null, "salePrices":null, "primaryFullImageURL":null, "listPrices":null, "productListingSku":null, "largeImageURLs":[ ], "productLine":null, "listVolumePrices":null, "primaryLargeImageURL":null, "smallImageURLs":[ ], "model":null, "id":"camcordersku_1_1", "thumbnailImage":null, "barcode":"200000000516", "saleVolumePrices":null, "salePriceEndDate":null, "saleVolumePrice":null, "salePriceStartDate":null, "images":[ ], "quantity":null, "unitOfMeasure":null, "salePrice":null, "primaryMediumImageURL":null, "fullImageURLs":[ ], "dynamicPropertyMapBigString":{ }, "active":true, "zoom":"2x optical/130x digital", "thumbImageURLs":[ ], "variantValuesOrder":{ }, "mediumImageURLs":[ ], "repositoryId":"camcordersku_1_1", "primarySourceImageURL":null, "primarySmallImageURL":null, "sourceImageURLs":[ ], "listPrice":null, "configurable":false }, { "productFamily":null, "dynamicPropertyMapLong":{ "sku-camcorder_zoom":3, "sku-camcorder_color":0 }, "primaryThumbImageURL":null, "largeImage":null, "smallImage":null, "color":"Black", "listVolumePrice":null, "salePrices":null, "primaryFullImageURL":null, "listPrices":null, "productListingSku":null, "largeImageURLs":[ ], "productLine":null, "listVolumePrices":null, "primaryLargeImageURL":null, "smallImageURLs":[ ], "model":null, "id":"camcordersku_1_2", "thumbnailImage":null, "barcode":"200000000523", "saleVolumePrices":null, "salePriceEndDate":null, "saleVolumePrice":null, "salePriceStartDate":null, "images":[ ], "quantity":null, "unitOfMeasure":null, "salePrice":null, "primaryMediumImageURL":null, "fullImageURLs":[ ], "dynamicPropertyMapBigString":{ }, "active":true, "zoom":"20x optical/320x digital", "thumbImageURLs":[ ], "variantValuesOrder":{ }, "mediumImageURLs":[ ], "repositoryId":"camcordersku_1_2", "primarySourceImageURL":null, "primarySmallImageURL":null, "sourceImageURLs":[ ], "listPrice":null, "configurable":false }, { "productFamily":null, "dynamicPropertyMapLong":{ "sku-camcorder_zoom":0, "sku-camcorder_color":2 }, "primaryThumbImageURL":null, "largeImage":null, "smallImage":null, "color":"Neon", "listVolumePrice":null, "salePrices":null, "primaryFullImageURL":null, "listPrices":null, "productListingSku":null, "largeImageURLs":[ ], "productLine":null, "listVolumePrices":null, "primaryLargeImageURL":null, "smallImageURLs":[ ], "model":null, "id":"camcordersku_1_3", "thumbnailImage":null, "barcode":"200000000530", "saleVolumePrices":null, "salePriceEndDate":null, "saleVolumePrice":null, "salePriceStartDate":null, "images":[ ], "quantity":null, "unitOfMeasure":null, "salePrice":null, "primaryMediumImageURL":null, "fullImageURLs":[ ], "dynamicPropertyMapBigString":{ }, "active":true, "zoom":"2x optical/130x digital", "thumbImageURLs":[ ], "variantValuesOrder":{ }, "mediumImageURLs":[ ], "repositoryId":"camcordersku_1_3", "primarySourceImageURL":null, "primarySmallImageURL":null, "sourceImageURLs":[ ], "listPrice":null, "configurable":false }, { "productFamily":null, "dynamicPropertyMapLong":{ "sku-camcorder_zoom":4 }, "primaryThumbImageURL":null, "largeImage":null, "smallImage":null, "color":null, "listVolumePrice":null, "salePrices":null, "primaryFullImageURL":null, "listPrices":null, "productListingSku":null, "largeImageURLs":[ ], "productLine":null, "listVolumePrices":null, "primaryLargeImageURL":null, "smallImageURLs":[ ], "model":null, "id":"camcordersku_1_4", "thumbnailImage":null, "barcode":"200000000547", "saleVolumePrices":null, "salePriceEndDate":null, "saleVolumePrice":null, "salePriceStartDate":null, "images":[ ], "quantity":null, "unitOfMeasure":null, "salePrice":null, "primaryMediumImageURL":null, "fullImageURLs":[ ], "dynamicPropertyMapBigString":{ }, "active":true, "zoom":"27x optical/320x digital", "thumbImageURLs":[ ], "variantValuesOrder":{ }, "mediumImageURLs":[ ], "repositoryId":"camcordersku_1_4", "primarySourceImageURL":null, "primarySmallImageURL":null, "sourceImageURLs":[ ], "listPrice":null, "configurable":false } ], "skuCount":4 } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|100094|Organization passed in the header is currently inactive|\n|100095|The order or return request does not belong to the current organization of the shopper profile|\n|100096|The organization associated to the order or return request was deleted / does not exist|\n|100097|The organization associated to the order or return request is currently inactive|\n|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|\n|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|\n|100101|The shopper profile does not belong to organization passed in the header|\n" } }, "parameters":[ { "in":"query", "name":"GiftWithPurchaseDetail", "description":"the gift detail of the free gift. This is typically a product or a sku Id", "type":"string", "required":true }, { "in":"query", "name":"GiftWithPurchaseType", "description":"the gift type of the free gift. For example product or sku", "type":"string", "required":true }, { "in":"header", "name":"x-ccsite", "description":"the site id on which the orders is laced", "type":"string", "required":false }, { "in":"header", "name":"X-CCOrganization", "description":"the organization Id in which order should be created", "type":"string", "required":false } ], "tags":[ "Agent/Orders" ], "x-internal-id":"ccagent-v1-orders-getGiftWithPurchaseChoices-get", "x-filename-id":"ccagent-v1-orders-getgiftwithpurchasechoices-get" } }, "/ccagent/v1/returnRequests/{id}/calculateRemainingRefund":{ "post":{ "summary":"calculateRemainingRefund", "produces":[ "application/json" ], "operationId":"calculateRemainingRefund", "description":"Endpoint to return suggested refund amount remaining in the price list group's currency as well as alternate currency in cases where allowAlternateCurrency flag at site level is true. Note that, this endpoint is just for suggesting remaining refund amount which need to be adjusted in refund methods", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/calculateRemainingRefund_response" }, "examples":{ "application/json":{ "remainingRefundAmountInPrimaryCurrency":0, "minimumAmountInSecondaryCurrency":17.42, "minimumAmountInPrimaryCurrency":53, "links":[ { "rel":"self", "href":"http://localhost:9080/ccagentui/v1/returnRequests/900001/calculateRemainingRefund" } ], "totalRefundAmount":53, "remainingRefundAmountInSecondaryCurrency":0 } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response" } }, "parameters":[ { "in":"path", "name":"id", "description":"The return request id.", "type":"string", "required":true }, { "schema":{ "$ref":"#/definitions/calculateRemainingRefund_request" }, "in":"body", "name":"calculateRemainingRefund_request" } ], "tags":[ "Agent/Return Order" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-returnRequests-{id}-calculateRemainingRefund-post", "x-filename-id":"ccagent-v1-returnrequests-id-calculateremainingrefund-post" } }, "/ccagent/v1/currencies/{id}":{ "get":{ "summary":"getCurrency", "produces":[ "application/json" ], "operationId":"getCurrency", "description":"Get Currency. Get a single currency item.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getCurrency_response" }, "examples":{ "application/json":{ "currencyType":null, "symbol":"$", "deleted":false, "displayName":"US Dollar", "repositoryId":"en_US", "fractionalDigits":2, "currencyCode":"USD", "numericCode":"840" } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|80011|The requested currency could not be found.|\n|80010|The request for currency was not valid.|\n" } }, "parameters":[ { "in":"path", "name":"id", "description":"The ID of the requested currency.", "type":"string", "required":true } ], "tags":[ "Agent/Currency" ], "x-internal-id":"ccagent-v1-currencies-{id}-get", "x-filename-id":"ccagent-v1-currencies-id-get" } }, "/ccagent/v1/adminProfiles/requestPasswordReset":{ "post":{ "summary":"requestPasswordReset", "produces":[ "application/json" ], "operationId":"requestPasswordReset", "description":"Request Password Reset. Request a password reset for a user", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/requestPasswordReset_response" }, "examples":{ "application/json":{ "success":"true" } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|60004|Resetting this account's password is not allowed. Check the link in your email and try again.|\n" } }, "parameters":[ { "schema":{ "$ref":"#/definitions/requestPasswordReset_request" }, "in":"body", "name":"requestPasswordReset_request" } ], "tags":[ "Agent/Internal Profiles" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-adminProfiles-requestPasswordReset-post", "x-filename-id":"ccagent-v1-adminprofiles-requestpasswordreset-post" } }, "/ccagent/v1/skus/{id}":{ "get":{ "summary":"getSku", "produces":[ "application/json" ], "operationId":"getSku", "description":"Get Sku. Returns sku details with pricing and variant information. Unlike the getSku endpoint of Admin, this endpoint returns pricing and variants details of Sku. Takes X-CCAgentContext header which is a JSON object with 'shopperProfileId' as a property. If 'shopperProfileId' is not provided, it is considered as an anonymous profile.Additonally takes x-ccsite header to return the sku's of that site'", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getSku_response" }, "examples":{ "application/json":{ "links":[ { "rel":"self", "href":"http://localhost:9080/ccagent/v1/variants/camcordersku_1_3" } ], "autoWrap":true, "items":[ { "dynamicPropertyMapLong":{ "sku-camcorder_zoom":0, "sku-camcorder_color":2 }, "bundleLinks":[ ], "largeImage":null, "smallImage":null, "endDate":null, "derivedCatalogs":[ ], "configurationMetadata":[ ], "type":"sku-camcorder", "derivedSalePriceFrom":"defaultPriceGroup", "translations":{ }, "id":"camcordersku_1_3", "wholesalePrice":null, "salePriceEndDate":null, "skuInfos":{ }, "creationDate":"2015-03-30T06:53:04.000Z", "version":1, "parentProducts":[ { "longDescription":"Record footage in 720p resolution with this Samsung F980BN\n HMX-F90BN/XAA flash memory camcorder, which features a CMOS sensor to help you capture high-definition\n videos. The 2. LCD display provides a clear view for shooting or reviewing images.\n ", "primaryThumbImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=100&width=100", "largeImage":null, "smallImage":null, "listVolumePrice":{ "bulkPrice":{ "numLevels":2, "levels":[ { "price":21, "levelMinimum":1, "levelMaximum":10 }, { "price":10, "levelMinimum":11 } ] } }, "displayName":"Samsung - F90BN HD Flash Memory Camcorder", "orderLimit":null, "onlineOnly":false, "description":null, "primaryFullImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg", "largeImageURLs":[ "/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=940&width=940" ], "primaryLargeImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=940&width=940", "addOnProducts":[ { "repositoryId":"cp10004", "configurationOptions":[ { "product":{ "displayName":"OM-D E-M10 Digital Compact System Camera", "repositoryId":"camera_1", "id":"camera_1", "type":"camera" }, "repositoryId":"co10009", "id":"co10009", "sku":{ "repositoryId":"camerasku_1_1", "id":"camerasku_1_1" } }, { "product":{ "displayName":"OM-D E-M10 Digital Compact System Camera", "repositoryId":"camera_1", "id":"camera_1", "type":"camera" }, "repositoryId":"co10010", "id":"co10010", "sku":{ "repositoryId":"camerasku_1_2", "id":"camerasku_1_2" } } ], "id":"cp10004" }, { "repositoryId":"cp10005", "configurationOptions":[ { "product":{ "displayName":"Movie Gift Card", "repositoryId":"giftCard_1", "id":"giftCard_1", "type":"giftCard" }, "repositoryId":"co10011", "id":"co10011", "sku":{ "repositoryId":"giftCardsku_1", "id":"giftCardsku_1" } } ], "id":"cp10005" } ], "smallImageURLs":[ "/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=300&width=300" ], "derivedShippingSurchargeFrom":"defaultPriceGroup", "derivedSalePriceFrom":"defaultPriceGroup", "id":"camcorder_1", "childSKUs":[ { "repositoryId":"camcordersku_1_1" }, { "repositoryId":"camcordersku_1_2" }, { "repositoryId":"camcordersku_1_3" }, { "repositoryId":"camcordersku_1_4" } ], "saleVolumePrice":{ "tieredPrice":{ "numLevels":2, "levels":[ { "price":18, "levelMinimum":1, "levelMaximum":10 }, { "price":8, "levelMinimum":11 } ] } }, "salePrice":null, "primaryMediumImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=475&width=475", "fullImageURLs":[ "/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg" ], "active":true, "thumbImageURLs":[ "/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=100&width=100" ], "productImages":[ { "repositoryId":"camcorderImg" } ], "route":"/product/camcorder_1", "mediumImageURLs":[ "/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=475&width=475" ], "repositoryId":"camcorder_1", "derivedListPriceFrom":"defaultPriceGroup", "primarySourceImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=300&width=300", "primarySmallImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=300&width=300", "sourceImageURLs":[ "/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=300&width=300" ], "minOrderLimit":1, "avgCustRating":null, "listPrice":null } ], "manufacturer_part_number":null, "catalogs":[ ], "startDate":null, "template":null, "replacementProducts":null, "dynamicAttributes":{ }, "fixedReplacementProducts":[ ], "color":"Neon", "nonreturnable":false, "displayName":"Camcorder", "description":null, "derivedOnlineOnly":false, "derivedShippingSurchargeFrom":"defaultPriceGroup", "itemAcl":null, "shippingSurcharges":{ "defaultPriceGroup":null }, "unit_of_measure":null, "onSale":false, "dynamicPropertyMapString":{ }, "siteIds":[ ], "thumbnailImage":null, "computedCatalogs":[ ], "discountable":true, "catalogsReplacementProducts":[ ], "salePriceStartDate":null, "quantity":null, "salePrice":597, "zoom":"2x optical/130x digital", "soldAsPackage":false, "auxiliaryMedia":{ }, "repositoryId":"camcordersku_1_3", "derivedListPriceFrom":"defaultPriceGroup", "shippingSurcharge":null, "fulfiller":null, "dynamicPropertyMapDouble":{ }, "listPrice":699.99 }, [ { "optionValue":"Neon", "optionName":"color" }, { "optionValue":"2x optical/130x digital", "optionName":"zoom" } ] ] } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|30015|SiteId passed in x-ccsite header is currently inactive|\n|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|\n|20033|Illegal to use catalog ID when custom catalogs are not in use.|\n|26069|Internal Error.|\n|26050|Variants Internal Error.|\n|26061|Cannot Find Null Sku.|\n|26060|Cannot Find Sku.|\n" } }, "parameters":[ { "in":"query", "name":"catalogId", "description":"ID of catalog. If a catalogId is not passed, the catalog associated with the shopperProfileId passed in the X-CCAgentContext header is used. If no shopperProfileId is passed in the header, default catalog associated with the site is used.", "type":"string", "required":false }, { "in":"query", "name":"showNotForIndividualSale", "description":"To retrieve not for indivisal Sale items. If showNotForIndividualSale is not passed the sku will return if it exists", "type":"boolean", "required":true }, { "in":"query", "name":"skuId", "description":"Sku Id.", "type":"string", "required":true }, { "in":"header", "name":"x-ccsite", "description":"the site id on which the orders is laced", "type":"string", "required":false }, { "in":"path", "name":"id", "description":"Sku Id.", "type":"string", "required":true } ], "tags":[ "Agent/Sku" ], "x-internal-id":"ccagent-v1-skus-{id}-get", "x-filename-id":"ccagent-v1-skus-id-get" } }, "/ccagent/v1/merchant/agentResponseHeaders":{ "get":{ "summary":"getAgentResponseHeaders", "produces":[ "application/json" ], "operationId":"getAgentResponseHeaders", "description":"Get custom response headers. Returns custom response headers for Agent. The payload is a mapping from header names to their escaped values.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getAgentResponseHeaders_response" }, "examples":{ "application/json":{ "X-Custom-Header":"test", "Content-Security-Policy":"default-src 'self' example.com" } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response" } }, "parameters":[ ], "tags":[ "Agent/Merchant Settings" ], "x-internal-id":"ccagent-v1-merchant-agentResponseHeaders-get", "x-filename-id":"ccagent-v1-merchant-agentresponseheaders-get" }, "put":{ "summary":"updateAgentResponseHeaders", "produces":[ "application/json" ], "operationId":"updateAgentResponseHeaders", "description":"Set custom response headers. The payload is a mapping from header names to their escaped values. Null values can be used to delete custom headers.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/updateAgentResponseHeaders_response" }, "examples":{ "application/json":{ "X-Content-Type-Options":null, "Content-Security-Policy":"default-src 'self' example.com" } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|221001|The following headers cannot be customized: {0}. Allowed response headers: {1}.|\n" } }, "parameters":[ { "schema":{ "$ref":"#/definitions/updateAgentResponseHeaders_request" }, "in":"body", "name":"updateAgentResponseHeaders_request" } ], "tags":[ "Agent/Merchant Settings" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-merchant-agentResponseHeaders-put", "x-filename-id":"ccagent-v1-merchant-agentresponseheaders-put" } }, "/ccagent/v1/verify":{ "post":{ "summary":"verify", "produces":[ "application/json" ], "operationId":"verify", "description":"Verify. Verify the auth status of a client.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/verify_response" }, "examples":{ "application/json":{ "success":true } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response" } }, "parameters":[ { "schema":{ "$ref":"#/definitions/verify_request" }, "in":"body", "name":"verify_request" } ], "tags":[ "Agent/OAuth" ], "x-internal-id":"ccagent-v1-verify-post", "x-filename-id":"ccagent-v1-verify-post" } }, "/ccagent/v1/sites/{id}":{ "get":{ "summary":"getSite", "produces":[ "application/json" ], "operationId":"getSite", "description":"Get Site. Get a site by ID. Optionally takes the x-ccasset-language header to get translated content in another language.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getSite_response" }, "examples":{ "application/json":{ "longDescription":null, "priceListGroupList":[ { "repositoryId":"defaultPriceGroup", "id":"defaultPriceGroup" } ], "inventoryLocationId":"SiteUS-GlenAllen187", "productionURL":"localhostSiteUS:8080", "description":"Commerce Cloud Site", "secondaryCurrency":"USD", "defaultCatalog":{ "repositoryId":"cloudLakeCatalog" }, "defaultBillingCountryId":null, "defaultShippingCountryId":null, "enabled":true, "payTaxInSecondaryCurrency":true, "defaultLocaleId":"1", "inventoryLocations":[ "SiteUS-GlenAllen187", "SiteUS-GlenAllen188" ], "loyaltyPrograms":[ { "programName":"Movie rewards", "repositoryId":"siteUS_LP0001", "associationDate":"2017-07-05T14:15:37.000Z", "programId":"LP0001" } ], "additionalProductionURLs":[ ], "id":"siteUS", "defaultSite":true, "additionalLocaleIds":[ ], "recommendationsHost":"recs.atgsvcs.example.com", "allowAlternateCurrency":true, "noimage":"/file/v3496256495527410201/general/19417364_10155381677403926_746513040903355218_o.jpg", "defaultPriceListGroup":{ "repositoryId":"defaultPriceGroup", "id":"defaultPriceGroup" }, "payShippingInSecondaryCurrency":true, "siteTypes":[ "commerce" ], "recommendationsPort":"8080", "repositoryId":"siteUS", "name":"Commerce Cloud Site" } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|30012|Could not get site for the id|\n|30011|Given Site id does not exist|\n|30016|Site internal error.|\n" } }, "parameters":[ { "in":"header", "name":"X-CCAsset-Language", "description":"The asset language of the request", "type":"string", "required":false }, { "in":"path", "name":"id", "description":"The ID of the site.", "type":"string", "required":true } ], "tags":[ "Agent/Sites" ], "x-internal-id":"ccagent-v1-sites-{id}-get", "x-filename-id":"ccagent-v1-sites-id-get" } }, "/ccagent/v1/ssoConfiguration":{ "get":{ "summary":"getSSOConfiguration", "produces":[ "application/json" ], "operationId":"getSSOConfiguration", "description":"Get SSO Configuration.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getSSOConfiguration_response" }, "examples":{ "application/json":{ "openIDEnabled":false, "SAMLEnabled":true, "IDCSEnabled":true } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response" } }, "tags":[ "Agent/OAuth" ], "x-internal-id":"ccagent-v1-ssoConfiguration-get", "x-filename-id":"ccagent-v1-ssoconfiguration-get" } }, "/ccagent/v1/returnRequests/{id}":{ "get":{ "summary":"getReturnRequest", "produces":[ "application/json" ], "operationId":"getReturnRequest", "description":"Get Return Request. Gets the return request details for a given ReturnRequestId. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getReturnRequest_response" }, "examples":{ "application/json":{ "returnRequestStatus":"Full return", "isExchangeRequest":false, "returnItems":[ { "quantityReturned":2, "deactivationDate":"2018-06-27T12:59:59Z", "dynamicProperties":[ { "id":"ReferralCode", "label":"ReferralCode", "value":null }, { "id":"OfferEndsDate", "label":"OfferEndsDate", "value":"2020-07-02T03:42:42.962Z" }, { "id":"Discount", "label":"Discount", "value":0 }, { "id":"GiftWrapping", "label":"Gift Wrapping", "value":false }, { "id":"CustomMessage", "label":"Custom Message", "value":null }, { "id":"name", "label":"Name on product(Mug)", "value":"My name" }, { "id":"ShippingInstructions", "label":"Shipping Instructions", "value":null } ], "displayName":"Playstation", "externalData":[ ], "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "orderDiscountShare":0, "childItems":[ { "serviceAccountId":"serviceAcc-123", "deactivationDate":"2018-06-27T12:59:59Z", "quantity":2, "productId":"prod10040", "displayName":"Super Smash Brothers Brawl", "externalData":[ ], "parentAssetKey":"123456", "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "childItems":[ { "serviceAccountId":"serviceAcc-123", "deactivationDate":"2018-06-27T12:59:59Z", "quantity":1, "productId":"prod10039", "displayName":"Wii Music", "externalData":[ ], "parentAssetKey":"23456", "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "rootAssetKey":"12345", "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"sku10047", "assetKey":"34567", "route":"product/prod10039", "customerAccountId":"customerAcc-123", "selectedOptions":[ ], "actionCode":"Add", "activationDate":"2017-06-27T15:30:00Z", "serviceId":"service-123", "asset":false } ], "rootAssetKey":"123456", "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"sku10041", "assetKey":"23456", "route":"product/prod10040", "customerAccountId":"customerAcc-123", "selectedOptions":[ ], "actionCode":"Add", "activationDate":"2017-06-27T15:30:00Z", "serviceId":"service-123", "asset":false }, { "serviceAccountId":"serviceAcc-123", "deactivationDate":"2018-06-27T12:59:59Z", "quantity":1, "productId":"prod10038", "displayName":"Wii Music", "externalData":[ ], "parentAssetKey":"12345", "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "rootAssetKey":"12345", "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"sku10042", "assetKey":"85748", "route":"product/prod10038", "customerAccountId":"customerAcc-123", "selectedOptions":[ ], "actionCode":"Add", "activationDate":"2017-06-27T15:30:00Z", "serviceId":"service-123", "asset":false } ], "skuOptionInfo":[ ], "configuratorId":"12345677", "assetKey":"12345", "quantityAvailableForReturn":3, "commerceItemId":"ci9000467", "unAdjustedRefundAmount":25, "suggestedShippingRefund":5.83, "price":115, "returnReason":"Incorrect Item", "actionCode":"Add", "promotionAdjustments":[ ], "serviceId":"service-123", "quantityReceived":1, "dispositionReason":{ "displayKey":"rejectedWithRefund", "displayName":"Rejected With Refund" }, "serviceAccountId":"serviceAcc-123", "unitPrice":25, "quantityToReturn":1, "comments":null, "productId":"prod10013", "returnItemId":"300002", "quantityToReceive":0, "suggestedTaxRefund":2.01, "shippingGroupId":"sg80417", "parentAssetKey":null, "manualAdjustmentShare":0, "rootAssetKey":null, "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"sku10030", "skuProperties":[ { "propertyType":"sku-base", "name":"Name", "id":"displayName", "value":null }, { "propertyType":"sku-base", "name":"Id", "id":"id", "value":"camerasku_1_1" }, { "propertyType":"sku-custom", "name":"dynamicskuprop1", "id":"dynamicskuprop1", "value":"dynamicskuprop1" } ], "customerAccountId":"customerAcc-123", "quantityShipped":5, "adjustedPromotionReferences":"", "additionalProperties":{ "property_2":"value_2", "property_1":"value_1" }, "activationDate":"2017-06-27T15:30:00Z", "asset":false, "actualRefundAmount":25, "suggestedRefundAmount":25 } ], "profileInfo":{ "lastName":"Anderson", "firstName":"Kim", "organization":{ "name":"Oracle India Pvt Ltd", "id":"oracle" }, "middleName":null, "email":"kim@example.com" }, "returnLabel":"return label 1", "isManuallyAdjusted":false, "authorizationNumber":"100001", "orderInfo":{ "originOfOrder":"contactCenter", "priceInfo":{ "total":156.82, "amount":110.2, "shipping":35, "isTaxIncluded":false, "tax":23.31, "subTotal":200, "orderDiscountAmount":2, "currencyCode":"USD", "totalWithoutTax":129.89 }, "recurringChargePriceInfo":{ "amount":20, "total":20, "shipping":0, "subTotalByFrequency":[ { "amount":20, "frequency":"Monthly" } ], "taxByFrequency":[ { "amount":0, "frequency":"Monthly" } ], "tax":0, "subTotal":20, "currencyCode":"USD", "totalWithoutTax":20 }, "orderId":"o10042", "priceListGroup":{ "deleted":false, "displayName":"UsDollar", "repositoryId":"UsDollar", "listPriceList":{ "repositoryId":"listPrices" }, "active":true, "salePriceList":{ "repositoryId":"salePrices" }, "currency":{ "symbol":"$", "displayName":"US Dollar", "repositoryId":"hi_US", "fractionalDigits":2, "currencyCode":"USD", "numericCode":"356" }, "id":"UsDollar", "locale":"hi_US", "shippingSurchargePriceList":{ "repositoryId":"shippingSurchargePrices" } }, "siteId":"siteUS", "creationDate":"2015-05-16T04:50:53.000Z", "submittedDate":"2015-06-16T04:50:53.000Z" }, "refundInfo":{ "shippingTaxRefund":2, "suggestedTaxRefund":2.01, "suggestedTotalRefund":32.84, "actualShippingRefund":5.83, "actualTaxRefund":2.01, "otherRefund":0, "refundDue":32.84, "suggestedShippingRefund":5.83, "returnFee":0, "suggestedOrderRefund":25, "appeasementRefundAdjustment":-15.3, "unAdjustedRefundSubtotal":25, "secondaryCurrencyAppeasementRefundAdjustment":0 }, "isSetteled":false, "promotionAdjustments":{ "promotionAdjustmentsCount":0, "orderPromotionValueAdjustments":[ ], "totalOrderDiscountAdjustment":0, "nonReturnItemCostAdjustment":[ ], "itemPromotionValueAdjustments":[ ], "manyToManyPromotionCouponAdjustment":{ } }, "links":[ { "rel":"self", "href":"http://localhost:9080/ccagentui/v1/returnRequests/300002" } ], "additionalProperties":{ "property2":"tag", "property":"display" }, "state":{ "displayKey":"FULL_RETURN", "displayName":"Full return" }, "quoteInfo":{ "providerNote":null, "notes":[ { "providerDate":"2016-11-25T13:33:48.000Z", "providerNote":"The quote is approved as per the request", "profileType":null, "profileId":"se-570031" }, { "profileType":null, "profileId":"se-570031", "requestDate":"2016-10-25T13:33:48.000Z", "requesterNote":"provide 10 percent off on the total quantity" } ], "rejectionDate":null, "requestDate":"2016-10-25T13:33:48.000Z", "errorInfo":null, "externalID":null, "rejectionNote":null, "quoteDate":"2016-10-25T13:35:32.000Z", "expirationDate":"2026-04-28T18:53:48.000Z" }, "trackingNumber":[ "http://localhost:9080/trackingNumber", "http://localhost:9080/trackingNumber2" ], "operation":"refund", "paymentReversalInfo":[ { "paymentGroupId":"pg10042", "refundType":"tokenizedCreditCard", "amount":32.84, "creditCardInfo":{ "cardNumber":"xxxxxxxxxxxx1111" }, "creditCardType":null, "reversalMethod":"Card Payment Reversal", "maxRefundAmount":156.82 } ] } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|100094|Organization passed in the header is currently inactive|\n|100095|The order or return request does not belong to the current organization of the shopper profile|\n|100096|The organization associated to the order or return request was deleted / does not exist|\n|100097|The organization associated to the order or return request is currently inactive|\n|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|\n|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|\n|200127|Internal error occurred.|\n|200131|Return Request Id passed in is null.|\n|200132|Return Request is not in pending refund state.|\n|30015|SiteId passed in x-ccsite header is currently inactive|\n|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|\n|30020|The Site to which the order belongs was deleted|\n|30021|The Site to which the order belongs is currently inactive|\n|100101|The shopper profile does not belong to organization passed in the header|\n|100102|Organization passed in the header is invalid or does not exist|\n|30019|SiteId passed in x-ccsite header is not related to the order being worked upon|\n" } }, "parameters":[ { "in":"header", "name":"X-CCOrganization", "description":"The organization Id to which the order belongs", "type":"string", "required":false }, { "in":"path", "name":"id", "description":"Id of returnRequest.", "type":"string", "required":true } ], "tags":[ "Agent/Return Order" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-returnRequests-{id}-get", "x-filename-id":"ccagent-v1-returnrequests-id-get" }, "put":{ "summary":"updateReturnRequest", "produces":[ "application/json" ], "operationId":"updateReturnRequest", "description":"Update Return Request. It updates the returnRequest based on the operation value. Operation value can be any of receiveReturns/initiateRefund/adjustRefundAmounts/markManualRefund/markAsComplete. Updates details of items received against a return request with operation set as 'receiveReturns'.Additonally takes x-ccsite header. If the site information is not provided by default it takes the order site. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/updateReturnRequest_response" }, "examples":{ "application/json":{ "returnRequestStatus":"Full return", "isExchangeRequest":false, "returnItems":[ { "quantityReturned":1, "deactivationDate":"2018-06-27T12:59:59Z", "dynamicProperties":[ { "id":"ReferralCode", "label":"ReferralCode", "value":null }, { "id":"OfferEndsDate", "label":"OfferEndsDate", "value":"2020-07-02T03:42:42.962Z" }, { "id":"Discount", "label":"Discount", "value":0 }, { "id":"GiftWrapping", "label":"Gift Wrapping", "value":false }, { "id":"CustomMessage", "label":"Custom Message", "value":null }, { "id":"name", "label":"Name on product(Mug)", "value":"My name" }, { "id":"ShippingInstructions", "label":"Shipping Instructions", "value":null } ], "displayName":"OM-D E-M10 Digital Compact System Camera", "externalData":[ ], "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "childItems":[ { "serviceAccountId":"serviceAcc-123", "deactivationDate":"2018-06-27T12:59:59Z", "quantity":2, "productId":"prod10040", "displayName":"Super Smash Brothers Brawl", "externalData":[ ], "parentAssetKey":"12345", "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "childItems":[ { "serviceAccountId":"serviceAcc-123", "deactivationDate":"2018-06-27T12:59:59Z", "quantity":1, "productId":"prod10039", "displayName":"Wii Music", "externalData":[ ], "parentAssetKey":"23456", "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "rootAssetKey":"12345", "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"sku10049", "assetKey":"34567", "route":"product/prod10039", "customerAccountId":"customerAcc-123", "selectedOptions":[ ], "actionCode":"Add", "activationDate":"2017-06-27T15:30:00Z", "serviceId":"service-123", "asset":false } ], "rootAssetKey":"12345", "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"sku10041", "assetKey":"84848", "route":"product/prod10040", "customerAccountId":"customerAcc-123", "selectedOptions":[ ], "actionCode":"Add", "activationDate":"2017-06-27T15:30:00Z", "serviceId":"service-123", "asset":false }, { "serviceAccountId":"serviceAcc-123", "deactivationDate":"2018-06-27T12:59:59Z", "quantity":1, "productId":"prod10038", "displayName":"Wii Music", "externalData":[ ], "parentAssetKey":"12345", "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "rootAssetKey":"12345", "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"sku10042", "assetKey":"93754", "route":"product/prod10038", "customerAccountId":"customerAcc-123", "selectedOptions":[ ], "actionCode":"Add", "activationDate":"2017-06-27T15:30:00Z", "serviceId":"service-123", "asset":false } ], "configuratorId":"12345677", "skuOptionInfo":[ { "optionValue":"Tan", "optionName":"color" }, { "optionValue":"30.8-megapixels", "optionName":"resolution" } ], "assetKey":"12345", "quantityAvailableForReturn":0, "commerceItemId":"ci9000467", "suggestedShippingRefund":35, "price":200, "returnReason":"Incorrect Item", "actionCode":"Add", "promotionAdjustments":[ ], "serviceId":"service-123", "quantityReceived":1, "dispositionReason":{ "displayKey":"acceptedWithRefund", "displayName":"Accepted With Refund" }, "serviceAccountId":"serviceAcc-123", "unitPrice":200, "quantityToReturn":1, "comments":null, "productId":"camera_1", "returnItemId":"100003", "quantityToReceive":0, "shippingGroupId":"sg80417", "suggestedTaxRefund":23.31, "parentAssetKey":null, "rootAssetKey":null, "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"camerasku_1_5", "skuProperties":[ { "propertyType":"sku-base", "name":"Name", "id":"displayName", "value":null }, { "propertyType":"sku-base", "name":"Id", "id":"id", "value":"camerasku_1_1" }, { "propertyType":"sku-custom", "name":"dynamicskuprop1", "id":"dynamicskuprop1", "value":"dynamicskuprop1" } ], "customerAccountId":"customerAcc-123", "quantityShipped":1, "adjustedPromotionReferences":"", "additionalProperties":{ "property2":"tag", "property":"display" }, "activationDate":"2017-06-27T15:30:00Z", "asset":false, "actualRefundAmount":200, "suggestedRefundAmount":200 } ], "returnLabel":"return label 1", "isManuallyAdjusted":false, "orderInfo":{ "originOfOrder":"contactCenter", "priceInfo":{ "total":256.31, "amount":198, "shipping":35, "isTaxIncluded":false, "tax":23.31, "subTotal":200, "orderDiscountAmount":2, "currencyCode":"USD", "totalWithoutTax":189.9 }, "recurringChargePriceInfo":{ "amount":20, "total":20, "shipping":0, "subTotalByFrequency":[ { "amount":20, "frequency":"Monthly" } ], "taxByFrequency":[ { "amount":0, "frequency":"Monthly" } ], "tax":0, "subTotal":20, "currencyCode":"USD", "totalWithoutTax":20 }, "orderId":"o10423", "siteId":"siteUS", "creationDate":"2015-03-27 15:53:01.0", "submittedDate":"2015-03-27 15:54:01.0" }, "refundInfo":{ "refundDue":256.31, "suggestedShippingRefund":35, "returnFee":0, "suggestedOrderRefund":200, "suggestedTaxRefund":23.31, "suggestedTotalRefund":256.31, "appeasementRefundAdjustment":0, "actualShippingRefund":35, "actualTaxRefund":23.31, "otherRefund":0, "secondaryCurrencyAppeasementRefundAdjustment":0 }, "isSetteled":false, "promotionAdjustments":{ "promotionAdjustmentsCount":1, "orderPromotionValueAdjustments":[ { "adjustedAmount":2, "promotionAdjustmentType":"Removed", "promotionDesc":"Order Discount - SAVE$2ON20 - Coupon", "couponCode":"SAVE2ON20", "promotionId":"explicitOrderDiscount2on20" } ], "totalOrderDiscountAdjustment":2, "nonReturnItemCostAdjustment":[ ], "itemPromotionValueAdjustments":[ ], "manyToManyPromotionCouponAdjustment":{ "SAVE2ON20":[ { "adjustedAmount":2, "promotionAdjustmentType":"Removed", "promotionDesc":"Order Discount - SAVE$2ON20 - Coupon", "promotionId":"explicitOrderDiscount2on20" } ] } }, "links":[ { "rel":"self", "href":"http://localhost:9080/ccagentui/v1/returnRequests/100003" } ], "additionalProperties":{ "property2":"tag", "property":"display" }, "quoteInfo":{ "providerNote":null, "notes":[ { "providerDate":"2016-11-25T13:33:48.000Z", "providerNote":"The quote is approved as per the request", "profileType":null, "profileId":"se-570031" }, { "profileType":null, "profileId":"se-570031", "requestDate":"2016-10-25T13:33:48.000Z", "requesterNote":"provide 10 percent off on the total quantity" } ], "rejectionDate":null, "requestDate":"2016-10-25T13:33:48.000Z", "errorInfo":null, "externalID":null, "rejectionNote":null, "quoteDate":"2016-10-25T13:35:32.000Z", "expirationDate":"2026-04-28T18:53:48.000Z" }, "trackingNumber":[ "http://localhost:9080/trackingNumber", "http://localhost:9080/trackingNumber2" ], "paymentReversalInfo":{ "creditCardInfo":{ "cardNumber":"xxxxxxxxxxxx1111" }, "reversalMethod":"Card Payment Reversal" } } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|100094|Organization passed in the header is currently inactive|\n|100095|The order or return request does not belong to the current organization of the shopper profile|\n|100096|The organization associated to the order or return request was deleted / does not exist|\n|100097|The organization associated to the order or return request is currently inactive|\n|200219|{0} is an inactive reason.|\n|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|\n|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|\n|200127|Internal error occurred.|\n|200218|{0} is an invalid reason.|\n|200126|Invalid Input Parameter.|\n|200125|Input passed in is null.|\n|200131|Return Request Id passed in is null.|\n|200132|Return Request is not in pending refund state.|\n|30015|SiteId passed in x-ccsite header is currently inactive|\n|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|\n|30020|The Site to which the order belongs was deleted|\n|30021|The Site to which the order belongs is currently inactive|\n|100101|The shopper profile does not belong to organization passed in the header|\n|30019|SiteId passed in x-ccsite header is not related to the order being worked upon|\n|200145|Refund amount cannot exceed payment group's amount.(Payment Group Type: {0}, Payment Group Id: {1})|\n" } }, "parameters":[ { "in":"header", "name":"x-ccsite", "description":"the site id on which the orders is laced", "type":"string", "required":false }, { "in":"header", "name":"X-CCOrganization", "description":"The organization Id to which the order belongs", "type":"string", "required":false }, { "in":"path", "name":"id", "description":"Return Request Id.", "type":"string", "required":true }, { "schema":{ "$ref":"#/definitions/updateReturnRequest_request" }, "in":"body", "name":"updateReturnRequest_request" } ], "tags":[ "Agent/Return Order" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-returnRequests-{id}-put", "x-filename-id":"ccagent-v1-returnrequests-id-put" } }, "/ccagent/v1/adminProfiles/sendPasswordReset":{ "post":{ "summary":"sendPasswordReset", "produces":[ "application/json" ], "operationId":"sendPasswordReset", "description":"Send Password Reset. Validate the reset token or set a user's new password. Send just the op and token to validate; send all of the values to reset the password.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/sendPasswordReset_response" }, "examples":{ "application/json":{ "success":"true" } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|83004|User login ID is required.|\n|60004|Resetting this account's password is not allowed. Check the link in your email and try again.|\n|83039|Passwords did not match.|\n" } }, "parameters":[ { "schema":{ "$ref":"#/definitions/sendPasswordReset_request" }, "in":"body", "name":"sendPasswordReset_request" } ], "tags":[ "Agent/Internal Profiles" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-adminProfiles-sendPasswordReset-post", "x-filename-id":"ccagent-v1-adminprofiles-sendpasswordreset-post" } }, "/ccagent/v1/prices/{id}":{ "get":{ "summary":"getAllPrices", "produces":[ "application/json" ], "operationId":"getAllPrices", "description":"Get All Prices. Return the the list and sale price for the product or SKU. This Endpoint is clone of StoreFront endpoint and it can be used if application running on agent/admin server need access the product prices data configured for StoreFront. Takes X-CCAgentContext header which is a JSON object with 'shopperProfileId' as a property. If 'shopperProfileId' is not provided, it is considered as an anonymous profile.Additonally takes x-ccsite header to return the data specific to the site.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getAllPrices_response" }, "examples":{ "application/json":{ "priceMin":596, "priceMax":599, "skuPrices":[ { "salePrice":599, "skuId":"camcordersku_1_1", "listPrice":699.99 }, { "salePrice":596, "skuId":"camcordersku_1_2", "listPrice":699.99 }, { "salePrice":597, "skuId":"camcordersku_1_3", "listPrice":699.99 }, { "salePrice":598, "skuId":"camcordersku_1_4", "listPrice":699.99 } ], "links":[ { "rel":"self", "href":"http://localhost:8080/ccstore/v1/prices/camcorder_1" } ], "priceRange":true } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|30015|SiteId passed in x-ccsite header is currently inactive|\n|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|\n|20031|Product Id prod10007 is invalid or non-existent.|\n" } }, "parameters":[ { "in":"query", "name":"showInactiveSkus", "description":"If it is false inactive skus will not be considered for calculating price range.", "type":"boolean", "required":false }, { "in":"header", "name":"x-ccsite", "description":"the site id on which the orders is laced", "type":"string", "required":false }, { "in":"path", "name":"id", "description":"The product ID.", "type":"string", "required":true } ], "tags":[ "Agent/Prices" ], "x-internal-id":"ccagent-v1-prices-{id}-get", "x-filename-id":"ccagent-v1-prices-id-get" } }, "/ccagent/v1/openid/sso":{ "post":{ "summary":"OpenID Single Sign On", "produces":[ "application/json" ], "operationId":"opeIDSingleSignOn", "description":"OpenID Single Sign On", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/openIDSingleSignOn_response" }, "examples":{ "application/json":{ "access_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MTQxNDk5NTYsInN1YiI6IjExMDU1OCIsImlzcyI6InN0b3JlZnJvbnRVSSIsImlhdCI6MTQxNDE0OTAyNn0=.B9qM0/VKpCNKvjCmOnUPv4RS7mkIDgKcP8RJPaVQGYU=", "refresh_token":"AQIDBAXlI-00TPsdgV2dpt3yZRjyyDBzCOP5Qkryo7O8mDqNNLpDPp5c0qHKB2Sq1Kjx_v1SuPS0rvtE1LDGIRKKoRZkMTEgRU5DUllQVElPTl9LRVkxNCB7djF9NCA=", "token_type":"bearer", "expires_in":3600 } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|52301|Internal Error.|\n" } }, "parameters":[ { "schema":{ "$ref":"#/definitions/openIDSingleSignOn_request" }, "in":"body", "name":"authz_code" }, { "schema":{ "$ref":"#/definitions/openIDSingleSignOn_request" }, "in":"body", "name":"code_verifier" } ], "tags":[ "Agent/OpenID" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-openid-sso-post", "x-filename-id":"ccagent-v1-openid-sso-post" } }, "/ccagent/v1/collections":{ "get":{ "summary":"listCollections", "produces":[ "application/json" ], "operationId":"listCollections", "description":"List Collections. Get a list of collections. Use the name query param to list the collections whose display name CONTAINS IGNORECASE the given search string. Use the categoryIds param to get a list of collections whose ids match those listed in the comma delimted string value. Either categoryIds or name must be provided. Optionally takes the x-ccasset-language header to get translated content in another language. Takes X-CCAgentContext header which is a JSON object with 'shopperProfileId' as a property. If 'shopperProfileId' is not provided, it is considered as an anonymous profile.Additonally takes x-ccsite header to return the data specific to the site. This endpoint also returns dynamic properties of a collection if exists.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/listCollections_response" }, "examples":{ "application/json":{ "longDescription":"Looking for an inspired quality gift? ATG Store gift shop has a wide choice of gifts for both men and women suitable for every occassion. Shopping for gifts is simple and convenient at ATG Store.com.", "route":"/gift-shop/category/cat50056", "lastModifiedDate":"2023-01-23T10:32:49.496Z", "categoryPaths":[ "/Commerce Root/Gift Shop" ], "displayName":"Gift Shop", "repositoryId":"cat50056", "active":false, "childCategories":[ { "longDescription":"Looking for gift ideas for him? Let us help you find that perfect gift for him at ATG Store. Shopping for gifts is simple and convenient at ATG Store.com.", "route":"/for-him/category/cat50067", "categoryPaths":[ "/Commerce Root/Gift Shop/For Him" ], "displayName":"For Him", "repositoryId":"cat50067", "active":false, "childCategories":null, "id":"cat50067", "fixedParentCategories":[ { "repositoryId":"cat50056" } ] }, { "longDescription":"Looking for gift ideas for her? Find that amazing gift that she'll love at ATG Store. Shopping for gifts is simple and convenient at ATG Store.com.", "route":"/for-her/category/cat60001", "categoryPaths":[ "/Commerce Root/Gift Shop/For Her" ], "displayName":"For Her", "repositoryId":"cat60001", "active":false, "childCategories":null, "id":"cat60001", "fixedParentCategories":[ { "repositoryId":"cat50056" } ] } ], "id":"cat50056", "fixedParentCategories":[ { "longDescription":"ATG Store commerce root", "route":"/commerce-root/category/rootCategory", "categoryPaths":[ "/Commerce Root" ], "displayName":"Commerce Root", "repositoryId":"rootCategory", "active":false, "childCategories":[ { "repositoryId":"cat50056" }, { "repositoryId":"cat50001" }, { "repositoryId":"catMen" }, { "repositoryId":"cat50097" }, { "repositoryId":"homeStoreRootCategory" }, { "repositoryId":"cat90028" }, { "repositoryId":"cat90030" } ], "id":"rootCategory", "fixedParentCategories":[ ] } ] } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|30015|SiteId passed in x-ccsite header is currently inactive|\n|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|\n|20142|Get Category Id Type Internal Error|\n|20141|Collection Id passed is null or empty|\n|20052|Get List Collections Type Internal Error|\n|20140|Collection Id is invalid or non-existent|\n" } }, "parameters":[ { "in":"query", "name":"categoryIds", "description":"List of collection ids to get.", "type":"string", "required":true }, { "in":"query", "name":"catalogId", "description":"ID of catalog. If a catalogId is not passed, the catalog associated with the shopperProfileId passed in the X-CCAgentContext header is used. If no shopperProfileId is passed in the header, default catalog associated with the site is used.", "type":"string", "required":false }, { "in":"query", "name":"name", "description":"Partial display name of a collection. 'true' if categoryIds not provided", "type":"string", "required":false }, { "in":"header", "name":"x-ccsite", "description":"the site id on which the orders is laced", "type":"string", "required":false } ], "tags":[ "Agent/Collections" ], "x-internal-id":"ccagent-v1-collections-get", "x-filename-id":"ccagent-v1-collections-get" } }, "/ccagent/v1/orders/reject":{ "post":{ "summary":"rejectOrder", "produces":[ "application/json" ], "operationId":"rejectOrder", "description":"Reject Order. Approver rejects an order. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value. If this header is not provided, then the endPoint will consider first active organization as the current organization for a B2B user.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/rejectOrder_response" }, "examples":{ "application/json":{ "gwp":false, "lastModifiedTime":"1488091242000", "priceGroupId":"defaultPriceGroup", "creationTime":"1488090529000", "gwpMarkers":[ ], "salesChannel":"contactCenter", "submittedDate":null, "locale":"en", "paymentGroups":[ { "expirationYear":null, "amountAuthorized":0, "amount":309.92, "gatewayName":null, "expirationMonth":null, "submittedDate":null, "authorizationStatus":[ ], "token":null, "paymentGroupClassType":"tokenizedCreditCard", "creditCardNumber":null, "paymentMethod":"tokenizedCreditCard", "state":"INITIAL", "id":"pg40411", "billingAddress":{ "lastName":null, "country":null, "address3":null, "address2":null, "city":null, "prefix":null, "address1":null, "postalCode":null, "companyName":null, "jobTitle":null, "county":null, "suffix":null, "ownerId":null, "selectedCountry":null, "firstName":null, "phoneNumber":null, "faxNumber":null, "middleName":null, "state":null, "email":null, "selectedState":null, "state_ISOCode":null }, "debitStatus":[ ], "currencyCode":"USD" } ], "configuratorId":null, "organizationId":"or-100002", "relationships":[ { "paymentGroupId":"pg40411", "amount":309.92, "relationshipType":"ORDERAMOUNTREMAINING", "id":"r50389" } ], "priceInfo":{ "discounted":false, "amount":249.99, "total":309.92, "shipping":35, "manualAdjustmentTotal":0, "amountIsFinal":false, "discountAmount":0, "tax":24.93, "rawSubtotal":249.99, "currencyCode":"USD" }, "submissionProgress":[ ], "totalCommerceItemCount":1, "id":"o40411", "state":"FAILED_APPROVAL", "quoteInfo":null, "taxCalculated":true, "commerceItems":[ { "deactivationDate":"2018-06-27T12:59:59Z", "returnedQuantity":0, "externalData":[ ], "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "assetKey":"12345", "priceInfo":{ "discounted":true, "amount":249.99, "rawTotalPrice":299.99, "salePrice":0, "priceListId":"listPrices", "quantityDiscounted":1, "amountIsFinal":false, "onSale":false, "shippingSurcharge":0, "discountable":true, "currentPriceDetailsSorted":[ { "discounted":true, "amount":249.99, "quantity":1, "amountIsFinal":false, "range":{ "lowBound":0, "highBound":0, "size":1 }, "tax":21.86, "orderDiscountShare":0, "detailedUnitPrice":249.99, "currencyCode":"USD" } ], "currencyCode":"USD", "listPrice":299.99 }, "catalogId":null, "externalPriceDetails":null, "actionCode":"Add", "id":"ci4000413", "serviceId":"service-123", "serviceAccountId":"serviceAcc-123", "quantity":1, "productId":"prod10015", "externalId":null, "parentAssetKey":null, "originalCommerceItemId":null, "rootAssetKey":null, "transactionDate":"2018-06-27T12:59:59Z", "catalogRefId":"sku10032", "customerAccountId":"customerAcc-123", "lineAttributes":[ ], "catalogKey":null, "productDisplayName":"Playstation 3", "siteId":"siteUS", "activationDate":"2017-06-27T15:30:00Z", "asset":false } ], "taxPriceInfo":{ "discounted":false, "valueAddedTax":0, "amount":24.93, "countyTax":0.71, "isTaxIncluded":false, "miscTax":6.41, "districtTax":0, "stateTax":17.1, "miscTaxInfo":{ "Special":6.41 }, "countryTax":0, "cityTax":0.71, "amountIsFinal":false, "currencyCode":"USD" }, "freezeDate":"2017-02-26T06:40:42.000Z", "shippingGroups":[ { "shippingMethod":"standardShippingMethod", "description":"sg50411", "submittedDate":null, "priceInfo":{ "discounted":false, "shippingTax":3.07, "amount":35, "rawShipping":35, "amountIsFinal":false, "currencyCode":"USD" }, "shipOnDate":null, "actualShipDate":null, "specialInstructions":{ }, "locationId":"SiteUS-GlenAllen187", "shippingAddress":{ "lastName":"Blooming", "country":"US", "address3":null, "address2":"Santa Clara County", "city":"San Jose", "prefix":null, "address1":"7 W Jackson Blvd", "postalCode":"95111", "companyName":"US Motor Works, Inc.", "jobTitle":null, "county":null, "suffix":null, "ownerId":null, "selectedCountry":"US", "firstName":"Ron", "phoneNumber":"408-752-3500", "faxNumber":null, "middleName":null, "state":"CA", "email":"ron@example.com", "selectedState":"NY", "state_ISOCode":"US-NY" }, "commerceItemRelationships":[ { "commerceItemId":"ci4000413", "inventoryLocationId":null, "amount":0, "quantity":1, "pointOfNoRevision":false, "relationshipType":"SHIPPINGQUANTITY", "returnedQuantity":0, "range":{ "lowBound":0, "highBound":0, "size":1 }, "commerceItemExternalId":null, "state":"INITIAL", "id":"r50387" } ], "state":"INITIAL", "id":"sg50411", "stateDetail":null, "trackingNumber":null, "handlingInstructions":[ ], "shippingGroupClassType":"hardgoodShippingGroup" } ], "taxExempt":false, "lastModifiedDate":"2017-02-26T06:40:42.000Z", "creationSiteId":"siteUS", "approvalSystemMessages":[ "Order is pending approval because total is greater than the approved order limit." ], "profile":{ "lastName":"Blooming", "firstName":"Ron", "shippingAddress":null, "middleName":null, "parentOrganization":{ "name":"US Motor Works, Inc.", "id":"or-100002" }, "email":"ron@example.com" }, "shippingGroupCount":1, "orderAction":"order", "paymentGroupCount":1, "submissionErrorCodes":[ ], "submissionErrorMessages":[ ], "profileId":"bb-110023", "siteId":"siteUS", "markers":[ ], "activeQuoteOrderId":null } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|100094|Organization passed in the header is currently inactive|\n|100095|The order or return request does not belong to the current organization of the shopper profile|\n|100096|The organization associated to the order or return request was deleted / does not exist|\n|100097|The organization associated to the order or return request is currently inactive|\n|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|\n|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|\n|100101|The shopper profile does not belong to organization passed in the header|\n" } }, "parameters":[ { "in":"header", "name":"X-CCSite", "description":"the site Id in which order should be created", "type":"string", "required":false }, { "in":"header", "name":"X-CCOrganization", "description":"the organization Id in which order should be created", "type":"string", "required":false }, { "schema":{ "$ref":"#/definitions/rejectOrder_request" }, "in":"body", "name":"rejectOrder_request" } ], "tags":[ "Agent/Orders" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-orders-reject-post", "x-filename-id":"ccagent-v1-orders-reject-post" } }, "/ccagent/v1/profiles/{id}":{ "post":{ "summary":"resetPassword", "produces":[ "application/json" ], "operationId":"resetPassword", "description":"Reset Password. Service Endpoint for resetting the user profile password by the Agent", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/resetPassword_response" }, "examples":{ "application/json":{ "success":true, "links":[ { "rel":"self", "href":"http://localhost:9080/ccagent/v1/profiles/" } ] } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|80106|An error occurred while generating the password and sending the notification|\n|23026|Provide valid input|\n|22024|{0}({1}) must be a String|\n" } }, "parameters":[ { "in":"path", "name":"id", "description":"User profile id", "type":"string", "required":true }, { "schema":{ "$ref":"#/definitions/resetPassword_request" }, "in":"body", "name":"resetPassword_request" } ], "tags":[ "Agent/Customers" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-profiles-{id}-post", "x-filename-id":"ccagent-v1-profiles-id-post" }, "get":{ "summary":"getProfile", "produces":[ "application/json" ], "operationId":"getProfile", "description":"Get Profile. Get details of a customer profile. Optionally takes X-CCOrganization & x-ccsite header.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getProfile_response" }, "examples":{ "application/json":{ "profileDetail":{ "lastName":"Butt", "GDPRProfileP13nConsentDate":"2018-03-21T13:10:08.463Z", "customerContactId":"CRMID_12345", "GDPRProfileP13nConsentGranted":true, "catalog":{ "repositoryId":"cloudLakeCatalog" }, "dynamicProperties":[ { "id":"dynamicPropertyMaritalStatus", "label":"Marital Status", "type":"string", "value":"Single" } ], "roles":[ { "associations":[ { "relatedItemId":"or-100001", "type":"organization" } ], "function":"buyer", "relativeTo":"or-100001", "repositoryId":"100002", "name":"Buyer", "id":"100002", "type":"organizationalRole" }, { "associations":[ { "relatedItemId":"or-100001", "type":"organization" } ], "function":"custom", "relativeTo":"or-100001", "repositoryId":"orgRole2", "name":"orgRole2", "id":"orgRole2", "type":"organizationalRole" } ], "contactBillingAddress":{ "lastName":"Anderson", "firstName":"Kim", "country":"US", "externalAddressId":"EXT_ADDR_1", "phoneNumber":"212-555-2150", "address2":null, "city":"Buffalo", "address1":"451 Brooks Ave", "postalCode":"14201", "county":null, "repositoryId":"se-990031", "state":"NY" }, "receiveEmail":"yes", "dateOfBirth":"2001-11-14T00:00:00.000Z", "secondaryAddresses":{ "Work":{ "lastName":"Anderson", "firstName":"Kim", "country":"US", "externalAddressId":"EXT_ADDR_1", "phoneNumber":"212-555-2150", "address2":null, "city":"Buffalo", "address1":"451 Brooks Ave", "postalCode":"14201", "county":null, "repositoryId":"se-970031", "state":"NY" }, "Mom' s house":{ "lastName":"Anderson", "firstName":"Dolores", "country":"US", "externalAddressId":"EXT_ADDR_1", "phoneNumber":"212-555-4321", "address2":null, "city":"Dewitt", "address1":"41 Wexford Rd ", "postalCode":"13214", "county":null, "repositoryId":"se-140010", "state":"NY" }, "Home":{ "lastName":"dd", "firstName":"sdf", "country":"US", "externalAddressId":"EXT_ADDR_1", "phoneNumber":"1231231231", "address2":"f", "city":"f", "address1":"dd", "postalCode":"36123", "county":null, "repositoryId":"se-980031", "state":"AL" } }, "locale":"en_US", "contactShippingAddress":{ "lastName":"dd", "firstName":"sdf", "country":"US", "externalAddressId":"EXT_ADDR_1", "phoneNumber":"1231231231", "address2":"f", "city":"f", "address1":"dd", "postalCode":"36123", "county":null, "repositoryId":"se-980031", "state":"AL" }, "parentOrganization":{ "name":"Oracle India Pvt Ltd", "repositoryId":"oracle", "punchoutUserId":"100012", "id":"oracle" }, "receiveEmailDate":"2018-03-21T13:10:08.463Z", "firstName":"James", "profileType":"b2b_user", "loyaltyPrograms":[ { "programName":"XTRAREWARDS", "membershipId":"abc123", "programId":"prog1", "status":"Enrolled" }, { "programName":"XTRAREWARDS", "membershipId":"xyz123", "programId":"prog2", "status":"RequestForEnrollment" } ], "repositoryId":"120099", "shippingAddress":{ "lastName":"Butt", "firstName":"James", "country":"United States", "externalAddressId":"EXT_ADDR_1", "phoneNumber":"504-845-1427", "address2":"", "city":"New Orleans", "address1":"6649 N Blue Gum St", "postalCode":"70116", "county":"Orleans", "repositoryId":"140010", "state":"Los Angeles" }, "id":"120099", "email":"jbutt@example.com", "daytimeTelephoneNumber":"", "shippingAddresses":[ { "lastName":"Anderson", "country":"United States", "address3":"", "address2":"", "city":"Syracuse", "prefix":"", "address1":"21 Cedar Ave", "postalCode":"13202", "jobTitle":"", "companyName":"", "county":"", "isDefaultAddress":false, "suffix":"", "selectedCountry":"US", "firstName":"Kim", "externalAddressId":"EXT_ADDR_1", "phoneNumber":"212-555-1977", "faxNumber":"", "middleName":"", "state":"New York", "selectedState":"NY", "state_ISOCode":"US-NY" }, { "lastName":"Butt", "country":"United States", "address3":"", "address2":"", "city":"New Orleans", "prefix":"", "address1":"6649 N Blue Gum St", "postalCode":"70116", "jobTitle":"", "companyName":"", "county":"Orleans", "isDefaultAddress":true, "suffix":"", "selectedCountry":"US", "firstName":"James", "externalAddressId":"EXT_ADDR_1", "phoneNumber":"504-845-1427", "faxNumber":"", "middleName":"", "state":"Los Angeles", "selectedState":"LA", "state_ISOCode":"US-LA" } ] }, "profileComments":[ { "repositoryId":"100002", "comment":"Item not received.", "creationDate":"2014-06-25 01:50:28.0" }, { "repositoryId":"100001", "comment":"Issue with shipping address.", "creationDate":"2014-06-25 01:50:20.0" } ], "hasIncompleteOrder":false } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|100094|Organization passed in the header is currently inactive|\n|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|\n|22000|Profile Id passed is null or empty.|\n|22001|Internal error occurred while processing the request.|\n|100101|The shopper profile does not belong to organization passed in the header|\n|200006|Profile comment retrieval failed.|\n|22002|No profile found with profile id|\n|100102|Organization passed in the header is invalid or does not exist|\n|200016|Internal error occurred while processing the profile orders request.|\n" } }, "parameters":[ { "in":"query", "name":"includedRoles", "description":"If no value is given, by default all organizational roles(including secondary organizations) will be returned. If value is 'organizationalRolesForCurrentOrganization', organizational roles for current organization are returned. If value is 'allRolesForCurrentOrganization', all roles for current organization are returned.", "type":"string", "required":false }, { "in":"header", "name":"x-ccsite", "description":"the site id corresponding to which site specific properties should be shown", "type":"string", "required":false }, { "in":"header", "name":"X-CCOrganization", "description":"The organization Id to which the profile belongs to", "type":"string", "required":false }, { "in":"path", "name":"id", "description":"The customer profile id.", "type":"string", "required":true } ], "tags":[ "Agent/Customers" ], "x-internal-id":"ccagent-v1-profiles-{id}-get", "x-filename-id":"ccagent-v1-profiles-id-get" }, "delete":{ "summary":"deleteProfile", "produces":[ "application/json" ], "operationId":"deleteProfile", "description":"Endpoint for deleting a profile.", "responses":{ "200":{ "description":"OK." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|13037|Missing required property: profileId|\n|22002|No profile found with profile id {0}.|\n|20561|An error occurred while trying to delete the profile with id {0}.|\n|20562|B2B profile is not allowed to be deleted.|\n" } }, "parameters":[ { "in":"path", "name":"id", "description":"The customer profile id.", "type":"string", "required":true } ], "tags":[ "Agent/Customers" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-profiles-{id}-delete", "x-filename-id":"ccagent-v1-profiles-id-delete" }, "put":{ "summary":"updateProfile", "produces":[ "application/json" ], "operationId":"updateProfile", "description":"Update Profile. Updates customer name, email address, phone number, shipping address and email marketing flag status of the profile depending on the profile ID. Dynamic Properties of profile can also be updated like any other attribute (\"dynamicPropertyKey\":\"dynamicPropertyValue\"). Takes additonal header parameter x-ccsite corresponding to which site specific properties should be updated. If x-ccsite value is not provided, it indicates default site.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/updateProfile_response" }, "examples":{ "application/json":{ "lastName":"Anderson", "GDPRProfileP13nConsentDate":"2018-03-21T13:10:08.463Z", "GDPRProfileP13nConsentGranted":true, "customerContactId":"CRMID_1", "dynamicProperties":[ { "id":"dynamicPropertyMaritalStatus", "label":"Marital Status", "type":"string", "value":"Married" } ], "contactBillingAddress":{ "lastName":"Anderson", "firstName":"Kim", "country":"US", "externalAddressId":"EXT_ADDR_1", "phoneNumber":"212-555-2150", "address2":null, "city":"Buffalo", "address1":"451 Brooks Ave", "postalCode":"14201", "county":null, "repositoryId":"se-990031", "state":"NY" }, "receiveEmail":"yes", "dateOfBirth":"2007-11-14T00:00:00.000Z", "secondaryAddresses":{ "Work":{ "lastName":"Anderson", "firstName":"Kim", "country":"US", "externalAddressId":"EXT_ADDR_1", "phoneNumber":"212-555-2150", "address2":null, "city":"Buffalo", "address1":"451 Brooks Ave", "postalCode":"14201", "county":null, "repositoryId":"se-970031", "state":"NY" }, "Mom' s house":{ "lastName":"Anderson", "firstName":"Dolores", "country":"US", "externalAddressId":"EXT_ADDR_1", "phoneNumber":"212-555-4321", "address2":null, "city":"Dewitt", "address1":"41 Wexford Rd ", "postalCode":"13214", "county":null, "repositoryId":"se-140010", "state":"NY" }, "Home":{ "lastName":"dd", "firstName":"sdf", "country":"US", "externalAddressId":"EXT_ADDR_1", "phoneNumber":"1231231231", "address2":"f", "city":"f", "address1":"dd", "postalCode":"36123", "county":null, "repositoryId":"se-980031", "state":"AL" } }, "locale":"en_US", "contactShippingAddress":{ "lastName":"dd", "firstName":"sdf", "country":"US", "externalAddressId":"EXT_ADDR_1", "phoneNumber":"1231231231", "address2":"f", "city":"f", "address1":"dd", "postalCode":"36123", "county":null, "repositoryId":"se-980031", "state":"AL" }, "receiveEmailDate":"2018-03-21T13:10:08.463Z", "firstName":"Kim", "profileType":"b2b_user", "repositoryId":"120117", "shippingAddress":{ "lastName":"Anderson", "firstName":"Kim", "country":"US", "externalAddressId":"EXT_ADDR_1", "phoneNumber":"212-555-1977", "address2":"", "city":"Montgomery", "address1":"21 Cedar Ave", "postalCode":"13202", "county":null, "repositoryId":"142021", "state":"NY" }, "id":"120117", "email":"kim@example.com", "daytimeTelephoneNumber":"212-555-1977", "shippingAddresses":[ { "lastName":"Anderson", "country":"United States", "address3":"", "address2":"", "city":"Syracuse", "prefix":"", "address1":"21 Cedar Ave", "postalCode":"13202", "jobTitle":"", "companyName":"", "county":"", "isDefaultAddress":false, "suffix":"", "selectedCountry":"US", "firstName":"Kim", "externalAddressId":"EXT_ADDR_1", "phoneNumber":"212-555-1977", "faxNumber":"", "middleName":"", "state":"New York", "selectedState":"NY", "state_ISOCode":"US-NY" }, { "lastName":"Anderson", "country":"United States", "address3":"", "address2":"", "city":"Montgomery", "prefix":"", "address1":"21 Cedar Ave", "postalCode":"13202", "jobTitle":"", "companyName":"", "county":"", "isDefaultAddress":true, "suffix":"", "selectedCountry":"US", "firstName":"Kim", "externalAddressId":"EXT_ADDR_1", "phoneNumber":"212-555-1977", "faxNumber":"", "middleName":"", "state":"New York", "selectedState":"NY", "state_ISOCode":"US-NY" } ] } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|200012|please provide valid input|\n|23010|City not specified in shipping address|\n|23011|Address line 1 not specified in shipping address|\n|22000|The profile id passes is null or empty.|\n|23012|No last name specified in shipping address|\n|22001|Internal error while getting the profile.|\n|23013|No first name specified in shipping address|\n|22002|No profile found with the given id.|\n|23015|Phone number not specified in shipping address|\n|23005|Invalid phone number in shipping address|\n|23007|No country specified in shipping address|\n|23008|Postal code not specified in shipping address|\n|13036|One of the dynamic properties is not writable by the Agent user|\n|23041|You cannot activate or inactivate this profile as it is linked to multiple accounts.|\n|" } }, "parameters":[ { "in":"header", "name":"x-ccsite", "description":"the site id corresponding to which site specific properties should be updated", "type":"string", "required":false }, { "in":"path", "name":"id", "description":"The customer profile id.", "type":"string", "required":true }, { "schema":{ "$ref":"#/definitions/updateProfile_request" }, "in":"body", "name":"updateProfile_request" } ], "tags":[ "Agent/Customers" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-profiles-{id}-put", "x-filename-id":"ccagent-v1-profiles-id-put" } }, "/ccagent/v1/payment/calculateRemainingBalance":{ "post":{ "summary":"calculateRemainingBalance", "produces":[ "application/json" ], "operationId":"calculateRemainingBalance", "description":"Get remaining order amount for mixed currency orders.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/calculateRemainingBalance_response" }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response" } }, "parameters":[ { "schema":{ "$ref":"#/definitions/calculateRemainingBalance_request" }, "in":"body", "name":"calculateRemainingBalance_request" } ], "tags":[ "Agent/Payment" ], "x-internal-id":"ccagent-v1-payment-calculateRemainingBalance-post", "x-filename-id":"ccagent-v1-payment-calculateremainingbalance-post" } }, "/ccagent/v1/priceListGroups":{ "get":{ "summary":"listPriceListGroups", "produces":[ "application/json" ], "operationId":"listPriceListGroups", "description":"List Price List Groups. Get a list of PriceListGroups.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/listPriceListGroups_response" }, "examples":{ "application/json":{ "total":2, "totalResults":2, "offset":0, "limit":250, "defaultPriceListGroup":{ "isTaxIncluded":false, "endDate":"2016-03-11T18:30:00.000Z", "displayName":"UsDollar", "listPriceList":{ "repositoryId":"listPrices" }, "active":false, "isPointsBased":false, "locale":"en_US", "shippingSurchargePriceList":{ "repositoryId":"shippingSurchargePrices" }, "taxCalculationType":"calculateTax", "repositoryId":"UsDollar", "salePriceList":{ "repositoryId":"salePrices" }, "currency":{ "symbol":"$", "displayName":"US Dollar", "repositoryId":"en_US", "fractionalDigits":2, "currencyCode":"USD", "numericCode":"840" }, "id":"UsDollar", "includeAllProducts":true, "startDate":"2016-03-10T18:30:00.000Z" }, "sort":[ { "property":"displayName", "order":"asc" } ], "items":[ { "endDate":"2016-03-11T18:30:00.000Z", "displayName":null, "listPriceList":{ "repositoryId":"listPrices" }, "active":false, "isPointsBased":false, "locale":"en_US", "shippingSurchargePriceList":null, "taxCalculationType":"calculateTax", "repositoryId":"UsDollar", "salePriceList":{ "repositoryId":"salePrices" }, "currency":{ "symbol":"$", "displayName":"US Dollar", "repositoryId":"en_US", "fractionalDigits":2, "currencyCode":"USD", "numericCode":"840" }, "id":"UsDollar", "includeAllProducts":true, "startDate":"2016-03-10T18:30:00.000Z" }, { "isTaxIncluded":false, "endDate":"2016-03-11T18:30:00.000Z", "displayName":"CanadianDollar", "listPriceList":{ "repositoryId":"CanadianDollar_listPrice" }, "active":false, "isPointsBased":false, "locale":"en_CA", "shippingSurchargePriceList":{ "repositoryId":"CanadianDollar_shippingSurchargePrice" }, "taxCalculationType":"calculateTax", "repositoryId":"CanadianDollar", "salePriceList":{ "repositoryId":"CanadianDollar_salePrice" }, "id":"CanadianDollar", "includeAllProducts":false, "startDate":"2016-03-10T18:30:00.000Z" } ] } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|20185|There was an error fetching the PriceListGroup list.|\n" } }, "parameters":[ { "in":"query", "name":"q", "description":"The search query string in SCIM format. Results will be filtered based on this query.", "type":"string", "required":false }, { "in":"query", "name":"offset", "description":"Index of the first element to return.", "type":"integer", "required":false }, { "in":"query", "name":"defaultFirst", "description":"This for displaying default PriceListGroup first in the list", "type":"boolean", "required":false }, { "in":"query", "name":"limit", "description":"The number of items to return.", "type":"integer", "required":false }, { "in":"query", "name":"siteId", "description":"Site ID of the site", "type":"string", "required":false }, { "in":"query", "name":"includeDeleted", "description":"If true, include soft deleted items in results. If false or not present, exclude them.", "type":"boolean", "required":false }, { "in":"query", "name":"active", "description":"If null, don't filter active/inactive items. If true or false, return only items where active has that value.", "type":"boolean", "required":false }, { "in":"query", "name":"sort", "description":"Sorting criteria.", "type":"string", "required":false } ], "tags":[ "Agent/PriceListGroup" ], "x-internal-id":"ccagent-v1-priceListGroups-get", "x-filename-id":"ccagent-v1-pricelistgroups-get" } }, "/ccagent/v1/returnRequests/{id}/receive":{ "put":{ "summary":"receiveReturnRequest", "produces":[ "application/json" ], "operationId":"receiveReturnRequest", "description":"Receive Return Request. Updates details of items received against a return request with operation set as 'receiveReturns'.Additonally takes x-ccsite header. If the site information is not provided by default it takes the order site. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/receiveReturnRequest_response" }, "examples":{ "application/json":{ "returnRequestStatus":"Full return", "isExchangeRequest":false, "returnItems":[ { "quantityReturned":1, "deactivationDate":"2018-06-27T12:59:59Z", "dynamicProperties":[ { "id":"ReferralCode", "label":"ReferralCode", "value":null }, { "id":"OfferEndsDate", "label":"OfferEndsDate", "value":"2020-07-02T03:42:42.000Z" }, { "id":"Discount", "label":"Discount", "value":10 }, { "id":"GiftWrapping", "label":"Gift Wrapping", "value":false }, { "id":"name", "label":"Name on product(Mug)", "value":"My name" }, { "id":"ShippingInstructions", "label":"Shipping Instructions", "value":null } ], "displayName":"OM-D E-M10 Digital Compact System Camera", "externalData":[ ], "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "childItems":[ { "serviceAccountId":"serviceAcc-123", "deactivationDate":"2018-06-27T12:59:59Z", "quantity":2, "productId":"prod10040", "displayName":"Super Smash Brothers Brawl", "externalData":[ ], "parentAssetKey":"12345", "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "childItems":[ { "serviceAccountId":"serviceAcc-123", "deactivationDate":"2018-06-27T12:59:59Z", "quantity":1, "productId":"prod10039", "displayName":"Wii Music I", "externalData":[ ], "parentAssetKey":"23456", "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "rootAssetKey":"12345", "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"sku10049", "assetKey":"34567", "route":"product/prod10039", "customerAccountId":"customerAcc-123", "selectedOptions":[ ], "actionCode":"Add", "activationDate":"2017-06-27T15:30:00Z", "serviceId":"service-123", "asset":false } ], "rootAssetKey":"12345", "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"sku10041", "assetKey":"23456", "route":"product/prod10040", "customerAccountId":"customerAcc-123", "selectedOptions":[ ], "actionCode":"Add", "activationDate":"2017-06-27T15:30:00Z", "serviceId":"service-123", "asset":false }, { "serviceAccountId":"serviceAcc-123", "deactivationDate":"2018-06-27T12:59:59Z", "quantity":1, "productId":"prod10038", "displayName":"Wii Music", "externalData":[ ], "parentAssetKey":"12345", "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "rootAssetKey":"1234", "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"sku10042", "assetKey":"93847", "route":"product/prod10038", "customerAccountId":"customerAcc-123", "selectedOptions":[ ], "actionCode":"Add", "activationDate":"2017-06-27T15:30:00Z", "serviceId":"service-123", "asset":false } ], "configuratorId":"12345677", "skuOptionInfo":[ { "optionValue":"Tan", "optionName":"color" }, { "optionValue":"30.8-megapixels", "optionName":"resolution" } ], "assetKey":"12345", "quantityAvailableForReturn":0, "commerceItemId":"ci9000467", "suggestedShippingRefund":35, "returnReasonId":"10001", "price":200, "returnReason":"Incorrect Item", "actionCode":"Add", "promotionAdjustments":[ ], "serviceId":"service-123", "quantityReceived":1, "dispositionReason":{ "displayKey":"acceptedWithRefund", "displayName":"Accepted With Refund" }, "serviceAccountId":"serviceAcc-123", "unitPrice":200, "quantityToReturn":1, "comments":null, "productId":"camera_1", "returnItemId":"100003", "quantityToReceive":0, "shippingGroupId":"sg80417", "suggestedTaxRefund":23.31, "parentAssetKey":null, "rootAssetKey":null, "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"camerasku_1_5", "customerAccountId":"customerAcc-123", "quantityShipped":1, "adjustedPromotionReferences":"", "additionalProperties":{ "property2":"tag", "property":"display" }, "activationDate":"2017-06-27T15:30:00Z", "asset":false, "actualRefundAmount":200, "suggestedRefundAmount":200 } ], "returnLabel":"return label 1", "isManuallyAdjusted":false, "orderInfo":{ "originOfOrder":"contactCenter", "priceInfo":{ "total":256.31, "amount":198, "shipping":35, "isTaxIncluded":false, "tax":23.31, "subTotal":200, "orderDiscountAmount":2, "currencyCode":"USD", "totalWithoutTax":189.9 }, "recurringChargePriceInfo":{ "amount":20, "total":20, "shipping":0, "subTotalByFrequency":[ { "amount":20, "frequency":"Monthly" } ], "taxByFrequency":[ { "amount":0, "frequency":"Monthly" } ], "tax":0, "subTotal":20, "currencyCode":"USD", "totalWithoutTax":20 }, "orderId":"o10423", "creationDate":"2015-03-27 15:53:01.0", "submittedDate":"2015-03-27 15:54:01.0" }, "refundInfo":{ "refundDue":256.31, "suggestedShippingRefund":35, "returnFee":0, "suggestedOrderRefund":200, "suggestedTaxRefund":23.31, "suggestedTotalRefund":256.31, "appeasementRefundAdjustment":0, "actualShippingRefund":35, "actualTaxRefund":23.31, "otherRefund":0, "secondaryCurrencyAppeasementRefundAdjustment":0 }, "isSetteled":false, "promotionAdjustments":{ "promotionAdjustmentsCount":1, "orderPromotionValueAdjustments":[ { "adjustedAmount":2, "promotionAdjustmentType":"Removed", "promotionDesc":"Order Discount - SAVE$2ON20 - Coupon", "couponCode":"SAVE2ON20", "promotionId":"explicitOrderDiscount2on20" } ], "totalOrderDiscountAdjustment":2, "nonReturnItemCostAdjustment":[ ], "itemPromotionValueAdjustments":[ ], "manyToManyPromotionCouponAdjustment":{ "SAVE2ON20":[ { "adjustedAmount":2, "promotionAdjustmentType":"Removed", "promotionDesc":"Order Discount - SAVE$2ON20 - Coupon", "promotionId":"explicitOrderDiscount2on20" } ] } }, "links":[ { "rel":"self", "href":"http://localhost:9080/ccagentui/v1/returnRequests/100003/receive" } ], "additionalProperties":{ "property2":"tag", "property":"display" }, "quoteInfo":{ "providerNote":null, "notes":[ { "providerDate":"2016-11-25T13:33:48.000Z", "providerNote":"The quote is approved as per the request", "profileType":null, "profileId":"se-570031" }, { "profileType":null, "profileId":"se-570031", "requestDate":"2016-10-25T13:33:48.000Z", "requesterNote":"provide 10 percent off on the total quantity" } ], "rejectionDate":null, "requestDate":"2016-10-25T13:33:48.000Z", "errorInfo":null, "externalID":null, "rejectionNote":null, "quoteDate":"2016-10-25T13:35:32.000Z", "expirationDate":"2026-04-28T18:53:48.000Z" }, "trackingNumber":[ "http://localhost:9080/trackingNumber", "http://localhost:9080/trackingNumber2" ], "paymentReversalInfo":{ "creditCardInfo":{ "cardNumber":"xxxxxxxxxxxx1111" }, "reversalMethod":"Card Payment Reversal" } } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|100094|Organization passed in the header is currently inactive|\n|100095|The order or return request does not belong to the current organization of the shopper profile|\n|100096|The organization associated to the order or return request was deleted / does not exist|\n|100097|The organization associated to the order or return request is currently inactive|\n|200219|{0} is an inactive reason.|\n|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|\n|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|\n|200127|Internal error occurred.|\n|200218|{0} is an invalid reason.|\n|200126|Invalid Input Parameter.|\n|200125|Input passed in is null.|\n|200131|Return Request Id passed in is null.|\n|200132|Return Request is not in pending refund state.|\n|30015|SiteId passed in x-ccsite header is currently inactive|\n|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|\n|30020|The Site to which the order belongs was deleted|\n|30021|The Site to which the order belongs is currently inactive|\n|100101|The shopper profile does not belong to organization passed in the header|\n|30019|SiteId passed in x-ccsite header is not related to the order being worked upon|\n" } }, "parameters":[ { "in":"header", "name":"x-ccsite", "description":"the site id on which the orders is laced", "type":"string", "required":false }, { "in":"header", "name":"X-CCOrganization", "description":"The organization Id to which the order belongs", "type":"string", "required":false }, { "in":"path", "name":"id", "description":"Return Request Id.", "type":"string", "required":true }, { "in":"header", "name":"X-CCAgentContext", "description":"Shopper profile id associated to the order", "type":"string", "required":false }, { "schema":{ "$ref":"#/definitions/receiveReturnRequest_request" }, "in":"body", "name":"receiveReturnRequest_request" } ], "tags":[ "Agent/Return Order" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-returnRequests-{id}-receive-put", "x-filename-id":"ccagent-v1-returnrequests-id-receive-put" } }, "/ccagent/v1/profiles/{id}/addresses/{addressId}":{ "get":{ "summary":"getProfileAddress", "produces":[ "application/json" ], "operationId":"getProfileAddress", "description":"Get Profile Address specific to the customer profile based on the address Id", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getProfileAddress_response" }, "examples":{ "application/json":{ "address":{ "firstName":"tr", "lastName":"et", "country":"US", "externalAddressId":"EXT_ADDR_1", "types":[ { "displayName":"Billing", "repositoryId":"ss-10002", "id":"SHIPPING" } ], "phoneNumber":"631-748-6479", "address2":"et", "city":"te", "address1":"et", "postalCode":"35005", "repositoryId":"130023", "state":"AL" }, "addressType":"tertr", "links":[ { "rel":"self", "href":"http://localhost:9080/ccagentui/v1/profiles/se-570031/addresses/130023" } ] } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|22030|User is not logged in|\n|22031|Internal error during get profile|\n|22032|Error occurred due to invalid data|\n|22002|No profile found with profile id|\n|89103|The current user does not have administrator privileges and is not associated to an account|\n|100190|Error occurred while attempting to fetch addresses from the repository.|\n|22038|Invalid Address ID : address is not associated with user profile.|\n|" } }, "parameters":[ { "in":"path", "name":"id", "description":"The customer profile id.", "type":"string", "required":true }, { "in":"path", "name":"addressId", "description":"The address Id associated to profile.", "type":"string", "required":true } ], "tags":[ "Agent/Customers" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-profiles-{id}-addresses-{addressId}-get", "x-filename-id":"ccagent-v1-profiles-id-addresses-addressid-get" }, "delete":{ "summary":"deleteProfileAddress", "produces":[ "application/json" ], "operationId":"deleteProfileAddress", "description":"Deletes the address associated to the profile and the address info. In order a B2B user to delete address, should have profile address manager role.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/deleteProfileAddress_response" }, "examples":{ "application/json":{ "repositoryId":"se-570031" } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|22030|User is not logged in|\n|22031|Internal error during get profile|\n|22032|Error occurred due to invalid data|\n|22002|No profile found with profile id|\n|89103|The current user does not have administrator privileges and is not associated to an account|\n|100190|Error occurred while attempting to fetch addresses from the repository.|\n|22038|Invalid Address ID : address is not associated with user profile.|\n" } }, "parameters":[ { "in":"path", "name":"id", "description":"The customer profile id.", "type":"string", "required":true }, { "in":"path", "name":"addressId", "description":"The address Id associated to profile.", "type":"string", "required":true } ], "tags":[ "Agent/Customers" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-profiles-{id}-addresses-{addressId}-delete", "x-filename-id":"ccagent-v1-profiles-id-addresses-addressid-delete" }, "put":{ "summary":"updateProfileAddress", "produces":[ "application/json" ], "operationId":"updateProfileAddress", "description":"Update profile address of the customer. If the customer is B2B, then the customer should have profile address manager role in that organization.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/updateProfileAddress_response" }, "examples":{ "application/json":{ "address":{ "firstName":"tr", "lastName":"et", "country":"US", "externalAddressId":"EXT_ADDR_1", "types":[ { "displayName":"Billing", "repositoryId":"ss-10002", "id":"SHIPPING" } ], "phoneNumber":"631-748-6479", "address2":"et", "city":"te", "address1":"et", "postalCode":"35005", "repositoryId":"130023", "state":"AL" }, "addressType":"tertr", "links":[ { "rel":"self", "href":"http://localhost:9080/ccagentui/v1/profiles/se-570031/addresses/130023" } ] } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|22030|User is not logged in|\n|22031|Internal error during get profile|\n|22032|Error occurred due to invalid data|\n|22002|No profile found with profile id|\n|89103|The current user does not have administrator privileges and is not associated to an account|\n|100190|Error occurred while attempting to fetch addresses from the repository.|\n|22038|Invalid Address ID : address is not associated with user profile.|\n|89101|User {0} does not have required permission to manage addresses.|\n|100186|Updating of multiple address is not allowed|\n|100183|Addresses is required|\n|23010|City is not specified|\n|23011|Address line 1 not specified|\n|22000|The profile id passes is null or empty.|\n|23012|No last name specified in shipping address|\n|22001|Internal error while getting the profile.|\n|23013|No first name specified in shipping address|\n|23015|Phone number not specified in shipping address|\n|23005|Invalid phone number is specified|\n|23007|No country is specified |\n|23008|Postal code is not specified|\n|100077|One of the dynamic properties is not writable by the Agent user|\n|180106|One or more address type ID is invalid|\n|" } }, "parameters":[ { "in":"path", "name":"id", "description":"The customer profile id.", "type":"string", "required":true }, { "in":"path", "name":"addressId", "description":"The address Id associated to profile.", "type":"string", "required":true }, { "schema":{ "$ref":"#/definitions/updateProfileAddress_request" }, "in":"body", "name":"updateProfileAddress_request" } ], "tags":[ "Agent/Customers" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-profiles-{id}-addresses-{addressId}-put", "x-filename-id":"ccagent-v1-profiles-id-addresses-addressid-put" } }, "/ccagent/v1/profiles/{id}/addresses":{ "post":{ "summary":"addProfileAddress", "produces":[ "application/json" ], "operationId":"addProfileAddress", "description":"Add profile address for a shopper. Any B2C user can add profile address. The B2B user needs to have profileAddressManager role in the current organization.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/addProfileAddress_response" }, "examples":{ "application/json":{ "address":{ "country":"US", "externalAddressId":"EXT_ADDR_1", "types":[ { "displayName":"Billing", "repositoryId":"ss-10002", "id":"ss-10001" } ], "phoneNumber":"907-385-4412", "address2":"", "city":"Anchorage", "address1":"639 Main St", "postalCode":"99501", "companyName":"National Discount Auto Parts", "repositoryId":"210026", "state":"AZ" }, "addressType":"Addr3ess313333312-Profile" } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|22031|Internal error during get profile|\n|22032|Error occurred due to invalid data|\n|22033|User is not logged in.|\n|22000|The profile id passes is null or empty.|\n|22001|Internal error while getting the profile.|\n|22002|No profile found with the given id.|\n|23005|Invalid phone number is specified|\n|23007|No country is specified|\n|23008|Postal code is not specified|\n|23010|City is not specified|\n|23011|Address line 1 not specified|\n|100077|One of the dynamic properties is not writable by the Agent user|\n||Invalid address type ID {0}|\n|180106|One or more address type ID is invalid|\n|" } }, "parameters":[ { "in":"path", "name":"id", "description":"The customer profile id.", "type":"string", "required":true }, { "schema":{ "$ref":"#/definitions/addProfileAddress_request" }, "in":"body", "name":"addProfileAddress_request" } ], "tags":[ "Agent/Customers" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-profiles-{id}-addresses-post", "x-filename-id":"ccagent-v1-profiles-id-addresses-post" }, "get":{ "summary":"listProfileAddresses", "produces":[ "application/json" ], "operationId":"listProfileAddresses", "description":"Get Profile Addresses specific to the customer profile.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/listProfileAddresses_response" }, "examples":{ "application/json":{ "total":2, "totalResults":2, "offset":0, "limit":8, "links":[ { "rel":"self", "href":"http://localhost:9080/ccagentui/v1/profiles/bb-110023/addresses?limit=8&offset=0" } ], "items":[ { "address":{ "lastName":null, "country":"US", "types":[ { "displayName":"shipping", "repositoryId":"ss-10002", "id":"SHIPPING" } ], "address2":null, "city":"sdf", "address1":"sdfs", "postalCode":"35005", "companyName":null, "county":null, "firstName":null, "externalAddressId":"EXT_ADDR_1", "phoneNumber":null, "repositoryId":"140065", "state":"AL" }, "addressType":"test2##0" }, { "address":{ "lastName":null, "country":"US", "types":[ { "displayName":"Billing", "repositoryId":"ss-10002", "id":"BILLING" } ], "address2":"dsfsd", "city":"sdf", "address1":"dsss", "postalCode":"35005", "companyName":null, "county":null, "firstName":null, "externalAddressId":"EXT_ADDR_1", "phoneNumber":null, "repositoryId":"140059", "state":"AL" }, "addressType":"This ##0" } ] } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|22030|User is not logged in|\n|22031|Internal error during get profile|\n|22032|Error occurred due to invalid data|\n|22002|No profile found with profile id|\n|89103|The current user does not have administrator privileges and is not associated to an account|\n|100190|Error occurred while attempting to fetch addresses from the repository.|\n" } }, "parameters":[ { "in":"path", "name":"id", "description":"The customer profile id.", "type":"string", "required":true }, { "in":"query", "name":"queryFormat", "description":"queryFormat to search on the address properties. Possible values SCIM or null.", "type":"string", "required":false }, { "in":"query", "name":"q", "description":"SCIM query to search on the address properties.", "type":"string", "required":false }, { "in":"query", "name":"addressType", "description":"Exact nick name to search.", "type":"string", "required":false }, { "in":"query", "name":"sort", "description":"This field determines the sort order of the list to be fetched.", "type":"string", "required":false }, { "in":"query", "name":"offset", "description":"This field determines the offset/starting index from which data to be fetched.", "type":"string", "required":false }, { "in":"query", "name":"limit", "description":"This is the field to determine number of records to be fetched per REST call.", "type":"string", "required":false }, { "in":"query", "name":"totalResults", "description":"Tells whether to include total and totalResults in the SCIM query.By default the value is true", "type":"boolean", "required":false } ], "tags":[ "Agent/Customers" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-profiles-{id}-addresses-get", "x-filename-id":"ccagent-v1-profiles-id-addresses-get" } }, "/ccagent/v1/saml/metadata/spCertificate":{ "get":{ "summary":"get Service Provider Signing Certificate", "produces":[ "text/xml" ], "operationId":"getSpCertificate", "description":"Get Service Provider Signing Certificate as PEM.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getSpCertificate_response" }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|51301|Internal Error.|\n" } }, "tags":[ "Agent/Agent Service Provider Entity Descriptor" ], "x-internal-id":"ccagent-v1-saml-metadata-spCertificate-get", "x-filename-id":"ccagent-v1-saml-metadata-spcertificate-get" } }, "/ccagent/v1/shopperTypes/{id}":{ "get":{ "summary":"getShopperType", "produces":[ "application/json" ], "operationId":"getShopperType", "description":"Get Shopper Type. Get information about shopper types by ID. Optionally takes the x-ccasset-language header to get translated content in another language.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getShopperType_response" }, "examples":{ "application/json":{ "propertiesOrder":[ "login", "password", "email", "autoLogin", "generatedPassword", "lastEmailed", "emailStatus", "receiveEmail", "lastPasswordGenerate", "lastActivity", "lastPasswordUpdate", "registrationDate", "derivedApprovalRequired", "firstName", "middleName", "derivedOrderPriceLimit", "lastName", "gender", "daytimeTelephoneNumber", "member", "userType", "locale", "securityStatus", "description", "realmId", "defaultCarrier", "abandonedOrderCount", "allowPartialShipment", "currentLocation", "accessTokenSigningKey", "expressCheckout" ], "displayName":"User", "links":[ { "rel":"self", "href":"http://localhost:9080/ccadminui/v1/shopperTypes/user?properties=%5Bobject%20Object%5D" } ], "id":"user", "properties":{ "lastName":{ "internalOnly":null, "default":null, "length":254, "textSearchable":false, "localizable":false, "label":"Last name", "type":"shortText", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "accessTokenSigningKey":{ "internalOnly":null, "default":null, "length":254, "textSearchable":false, "localizable":false, "label":"accessTokenSigningKey", "type":"shortText", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "gender":{ "internalOnly":null, "default":"female", "length":32, "textSearchable":false, "localizable":false, "label":"Gender", "type":"shortText", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "generatedPassword":{ "internalOnly":null, "default":false, "length":1, "textSearchable":false, "localizable":false, "label":"Generated password", "type":"checkbox", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "allowPartialShipment":{ "internalOnly":null, "default":false, "length":1, "textSearchable":false, "localizable":false, "label":"Allow partial shipment", "type":"checkbox", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "defaultCarrier":{ "internalOnly":null, "default":null, "length":254, "textSearchable":false, "localizable":false, "label":"Default carrier", "type":"shortText", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "description":{ "internalOnly":null, "default":null, "length":254, "textSearchable":false, "localizable":false, "label":"Description", "type":"shortText", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "locale":{ "internalOnly":null, "default":null, "length":32, "textSearchable":false, "localizable":false, "label":"Locale", "type":"shortText", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "login":{ "internalOnly":null, "default":null, "length":254, "textSearchable":false, "localizable":false, "label":"Login name", "type":"shortText", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "searchable" ], "required":true, "searchable":false, "multiSelect":null }, "securityStatus":{ "internalOnly":null, "default":0, "length":10, "textSearchable":false, "localizable":false, "label":"Security status", "type":"number", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "autoLogin":{ "internalOnly":null, "default":false, "length":1, "textSearchable":false, "localizable":false, "label":"Auto login", "type":"checkbox", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "password":{ "internalOnly":null, "default":null, "length":254, "textSearchable":false, "localizable":false, "label":"Password", "type":"shortText", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "searchable" ], "required":true, "searchable":false, "multiSelect":null }, "registrationDate":{ "internalOnly":null, "default":"2015-08-04T03:42:42.876Z", "length":26, "textSearchable":false, "localizable":false, "label":"Registration date", "type":"date", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "member":{ "internalOnly":null, "default":false, "length":1, "textSearchable":false, "localizable":false, "label":"Member", "type":"checkbox", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "lastPasswordGenerate":{ "internalOnly":null, "default":null, "length":26, "textSearchable":false, "localizable":false, "label":"lastPasswordGenerate", "type":"date", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "email":{ "internalOnly":null, "default":null, "length":254, "textSearchable":false, "localizable":false, "label":"Email address", "type":"shortText", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "daytimeTelephoneNumber":{ "internalOnly":null, "default":null, "length":254, "textSearchable":false, "localizable":false, "label":"Daytime telephone number", "type":"shortText", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "realmId":{ "internalOnly":null, "default":null, "length":254, "textSearchable":false, "localizable":false, "label":"Profile Realm", "type":"shortText", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "derivedOrderPriceLimit":{ "internalOnly":null, "default":null, "length":22, "textSearchable":false, "localizable":false, "label":"Order limit", "type":"number", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "receiveEmail":{ "internalOnly":null, "default":"yes", "length":32, "textSearchable":false, "localizable":false, "label":"Receive email", "type":"shortText", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "lastEmailed":{ "internalOnly":null, "default":null, "length":26, "textSearchable":false, "localizable":false, "label":"lastEmailed", "type":"date", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "currentLocation":{ "internalOnly":null, "default":"unknown", "length":0, "textSearchable":false, "localizable":false, "label":"Current location", "type":"shortText", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "abandonedOrderCount":{ "internalOnly":null, "default":null, "length":10, "textSearchable":false, "localizable":false, "label":"Number of abandoned orders", "type":"number", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "firstName":{ "internalOnly":null, "default":null, "length":254, "textSearchable":false, "localizable":false, "label":"First name", "type":"shortText", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "emailStatus":{ "internalOnly":null, "default":"unknown", "length":32, "textSearchable":false, "localizable":false, "label":"Email status", "type":"shortText", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "derivedApprovalRequired":{ "internalOnly":null, "default":false, "length":1, "textSearchable":false, "localizable":false, "label":"Approval required", "type":"checkbox", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "expressCheckout":{ "internalOnly":null, "default":false, "length":1, "textSearchable":false, "localizable":false, "label":"Express checkout", "type":"checkbox", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "lastPasswordUpdate":{ "internalOnly":null, "default":"2015-08-04T03:42:42.962Z", "length":26, "textSearchable":false, "localizable":false, "label":"Last password update", "type":"date", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "lastActivity":{ "internalOnly":null, "default":null, "length":26, "textSearchable":false, "localizable":false, "label":"Last activity", "type":"date", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "middleName":{ "internalOnly":null, "default":null, "length":254, "textSearchable":false, "localizable":false, "label":"Middle name", "type":"shortText", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null }, "userType":{ "internalOnly":null, "default":null, "length":10, "textSearchable":false, "localizable":false, "label":"User type", "type":"number", "dimension":false, "editableAttributes":[ "textSearchable", "multiSelect", "dimension", "internalOnly", "default", "label", "required", "searchable" ], "required":false, "searchable":false, "multiSelect":null } } } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|75001|Not supported type|\n" } }, "parameters":[ { "in":"header", "name":"X-CCAsset-Language", "description":"The asset language of the request", "type":"string", "required":false }, { "in":"path", "name":"id", "description":"ID of shopper type.", "type":"string", "required":true } ], "tags":[ "Agent/Shopper Types" ], "x-internal-id":"ccagent-v1-shopperTypes-{id}-get", "x-filename-id":"ccagent-v1-shoppertypes-id-get" } }, "/ccagent/v1/profileRequests":{ "get":{ "summary":"listProfileRequests", "produces":[ "application/json" ], "operationId":"listProfileRequests", "description":"List Profile Requests. This operation is used to get the collection of profile requests from Oracle Commerce Cloud. It can also be used to return the list on a searched string and in a sorted order against various properties of profile request.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/listProfileRequests_response" }, "examples":{ "application/json":{ "total":1, "totalResults":1, "offset":0, "limit":1, "links":[ { "rel":"self", "href":"http://example.com:9080/ccagentui/v1/profileRequests" } ], "items":[ { "requestedOrganizationName":"Oracle", "organization":{ "id":"100001" }, "profile":{ "firstName":"User", "lastName":"Test", "customerContactId":"CRMID_1", "id":"100001", "email":"user@example.com" }, "requestedOrganizationID":null, "id":100001, "status":"approved" } ], "___etag___":"eyJ2ZXJzaW9uIjowLCJ1cmkiOiJvcmdhbml6YXRpb25SZXF1ZXN0cyIsImhhc2giOiJ4S1JsMHc9PSJ9" } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|85000|Invalid Query Expression.|\n|50012|Invalid Sort options.|\n|10002|The value x for parameter 'y' is invalid. 'y' can be 'limit', 'offset'.|\n|100019|If there was any internal error while getting profile requests list.|\n" } }, "parameters":[ { "in":"query", "name":"q", "description":"Query string built as per the SCIM standards that helps to search entered string across profile request properties like 'requestedOrganizationName'.", "type":"string", "required":false }, { "in":"query", "name":"offset", "description":"This field determines the offset/starting index from which data to be fetched.", "type":"string", "required":false }, { "in":"query", "name":"limit", "description":"This is the field to determine number of records to be fetched per REST call.", "type":"string", "required":false }, { "in":"query", "name":"sort", "description":"This field determines the sort order of the list to be fetched.", "type":"string", "required":false } ], "tags":[ "Agent/Profile Request" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-profileRequests-get", "x-filename-id":"ccagent-v1-profilerequests-get" } }, "/ccagent/v1/merchant/cloudConfiguration":{ "get":{ "summary":"getCloudConfiguration", "produces":[ "application/json" ], "operationId":"getCloudConfiguration", "description":"Get Cloud Configuration. Gets the configurations from server.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getCloudConfiguration_response" }, "examples":{ "application/json":{ "isShowTaxSummaryEnabled":true, "excludeAddressList":false, "isB2BEnabled":false, "enableCustomOrganizationId":false, "clientConfiguration":{ "includeOrderDetailsInShippingMethodsPayload":true, "createOrderForLoggedInAtCheckout":false }, "allowReturnOnPartiallyFulfilledOrder":false, "strictExtraPropertiesValidation":true, "enablePurchaseListItemCustomPropertiesAsKeys":false, "enablePciCompliance":false, "isAgentAppEnabled":true, "enableChildEntitiesLimit":false, "enableDefaultSortForListProducts":false, "maxChildItemsCount":1000, "useOrderSubmittedDateForTax":false } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|30012|Could not get site {0}|\n" } }, "tags":[ "Agent/Merchant Settings" ], "x-internal-id":"ccagent-v1-merchant-cloudConfiguration-get", "x-filename-id":"ccagent-v1-merchant-cloudconfiguration-get" } }, "/ccagent/v1/personalDataReports/requests":{ "post":{ "summary":"createClickstreamRequest", "produces":[ "application/json" ], "operationId":"createClickstreamRequest", "description":"Request a clickstream history report for a given shopper.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/clickstreamReportRecord" }, "description":"ID and information about requested clickstream report" }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"Error response" } }, "parameters":[ { "schema":{ "$ref":"#/definitions/createClickstreamRequest_request" }, "in":"body", "name":"createClickstreamRequest_request" } ], "tags":[ "Agent/Privacy" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-personalDataReports-requests-post", "x-filename-id":"ccagent-v1-personaldatareports-requests-post" }, "get":{ "summary":"listClickstreamRequests", "produces":[ "application/json" ], "operationId":"listClickstreamRequests", "description":"Retreive records of clickstream history reports", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/clickstreamReportList_response" }, "description":"List of clickstream report records" }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"Error response" } }, "tags":[ "Agent/Privacy" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-personalDataReports-requests-get", "x-filename-id":"ccagent-v1-personaldatareports-requests-get" } }, "/ccagent/v1/locations":{ "get":{ "summary":"listLocations", "produces":[ "application/json" ], "operationId":"listLocations", "description":"List Locations. Retrieves and lists all the available locations using the given query options for paging and sorting.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/listLocations_response" }, "examples":{ "application/json":{ "total":1, "totalResults":1, "offset":0, "limit":1, "links":[ { "rel":"self", "href":"https://www.example.com/ccagent/v1/locations" } ], "sort":[ { "property":"locationId", "order":"asc" } ], "items":[ { "country":"USA", "distance":null, "endDate":"2017-04-25T00:00:00.000Z", "city":"Glen Allen", "latitude":37.6659833, "postalCode":"23060", "county":"Henrico", "stateAddress":"VA", "pickUp":false, "sites":[ { "id":"siteUS" }, { "id":"siteCA" } ], "inventory":false, "type":"store", "locationId":"GlenAllen187", "email":"store187@example.com", "longitude":-77.5063697, "hours":"9:00am - 5:00pm", "address3":null, "address2":"Suite 101", "address1":"4870 Sadler Rd.", "externalLocationId":"187", "phoneNumber":"(617) 386-1200", "repositoryId":"4000345", "name":"Glen Allen #187", "faxNumber":"(617) 386-1200", "startDate":"2016-04-25T00:00:00.000Z" } ] } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response" } }, "parameters":[ { "in":"query", "name":"q", "description":"This field specifies the query used to filter results. Defaults to SCIM.", "type":"string", "required":false }, { "in":"query", "name":"total", "description":"The total number of location items.", "type":"integer", "required":false }, { "in":"query", "name":"offset", "description":"Index of the first location item to return. The default is 0.", "type":"integer", "required":false }, { "in":"query", "name":"limit", "description":"The number of location items to return. The default is 10.", "type":"integer", "required":false }, { "in":"query", "name":"sort", "description":"The location items sorting criteria. Following are the fields supported by this param: \n\n|Field|Type|Description|\n|------------------|------------------|------------------|\n|property|string|The property by which to sort the list of location items. The default is locationId.|\n|order|string|The sort order, either 'asc' (ascending) or 'desc' (decending). The default is 'asc'.|\n", "type":"string", "required":false } ], "tags":[ "Agent/Locations" ], "x-internal-id":"ccagent-v1-locations-get", "x-filename-id":"ccagent-v1-locations-get" } }, "/ccagent/v1/products":{ "get":{ "summary":"listProducts", "produces":[ "application/json" ], "operationId":"listProducts", "description":"List Products. Gets a list of products. Optionally search for products in the given catalog and collection whose display name CONTAINS IGNORECASE the given search string. Optionally takes the x-ccasset-language header to get translated content in another language. Takes X-CCAgentContext header which is a JSON object with 'shopperProfileId' as a property. If 'shopperProfileId' is not provided, it is considered as an anonymous profile.Additonally takes x-ccsite header to return the data specific to the site", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/listProducts_response" }, "examples":{ "application/json":{ "totalResults":3, "offset":0, "limit":250, "links":[ { "rel":"self", "href":"http://localhost:9080/ccagentui/v1/products?delegatedAdminAllowedThroughAgent=true&orderApprovalsAllowedThroughAgent=true" } ], "sort":[ { "property":"displayName", "order":"asc" } ], "items":[ { "longDescription":"It's Samantha Baker's Sweet Sixteen and no one in her family remembers\n the important occasion. John Hughes, the writer of National Lampoon's Vacation, shows how coming-of-age\n can be full of surprises in this warm-hearted teenage comedy starring Molly Ringwald. She's your average\n teen, enduring creepy freshmen, spoiled siblings, confused parents and the Big Blonde on Campus who\n stands between her and the boy of her dreams. But wait...the day isn't over yet! This sparkling film\n features a dynamic score, and outstanding performances by Paul Dooley, Emmy winner Blanche Baker and\n Oscar nominee Justin Henry.\n ", "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg&height=100&width=100", "largeImage":null, "smallImage":null, "nonreturnable":false, "displayName":"16 Candles", "orderLimit":null, "onlineOnly":true, "description":"A really great movie that you should not miss.", "listPrices":null, "salePrices":null, "primaryFullImageURL":"/ccstore/v1/images/?source=/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg", "type":null, "largeImageURLs":[ "/ccstore/v1/images/?source=/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg&height=940&width=940" ], "primaryLargeImageURL":"/ccstore/v1/images/?source=/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg&height=940&width=940", "addOnProducts":[ { "repositoryId":"cp10004", "configurationOptions":[ { "product":{ "displayName":"OM-D E-M10 Digital Compact System Camera", "repositoryId":"camera_1", "id":"camera_1", "type":"camera" }, "repositoryId":"co10009", "id":"co10009", "sku":{ "repositoryId":"camerasku_1_1", "id":"camerasku_1_1" } }, { "product":{ "displayName":"OM-D E-M10 Digital Compact System Camera", "repositoryId":"camera_1", "id":"camera_1", "type":"camera" }, "repositoryId":"co10010", "id":"co10010", "sku":{ "repositoryId":"camerasku_1_2", "id":"camerasku_1_2" } } ], "id":"cp10004" }, { "repositoryId":"cp10005", "configurationOptions":[ { "product":{ "displayName":"Movie Gift Card", "repositoryId":"giftCard_1", "id":"giftCard_1", "type":"giftCard" }, "repositoryId":"co10011", "id":"co10011", "sku":{ "repositoryId":"giftCardsku_1", "id":"giftCardsku_1" } } ], "id":"cp10005" } ], "derivedShippingSurchargeFrom":"defaultPriceGroup", "smallImageURLs":[ "/ccstore/v1/images/?source=/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg&height=300&width=300" ], "derivedSalePriceFrom":"defaultPriceGroup", "shippingSurcharges":null, "id":"Product_19Cxy", "filteredSKUs":[ { "dynamicPropertyMapLong":{ }, "largeImage":null, "smallImage":null, "listVolumePrice":null, "listPrices":null, "configurationMetadata":[ ], "largeImageURLs":[ ], "productLine":null, "listVolumePrices":null, "derivedSalePriceFrom":"defaultPriceGroup", "model":null, "id":"Sku_19Dxy", "barcode":"200000000134", "salePriceEndDate":null, "images":[ ], "unitOfMeasure":null, "primaryMediumImageURL":null, "dynamicPropertyMapBigString":{ }, "active":true, "thumbImageURLs":[ ], "mediumImageURLs":[ ], "primarySourceImageURL":null, "primarySmallImageURL":null, "sourceImageURLs":[ ], "productFamily":null, "primaryThumbImageURL":null, "nonreturnable":false, "displayName":null, "salePrices":null, "primaryFullImageURL":null, "productListingSku":null, "primaryLargeImageURL":null, "derivedOnlineOnly":true, "derivedShippingSurchargeFrom":"defaultPriceGroup", "smallImageURLs":[ ], "shippingSurcharges":{ "defaultPriceGroup":null }, "thumbnailImage":null, "saleVolumePrices":null, "saleVolumePrice":null, "salePriceStartDate":null, "quantity":15, "salePrice":4.99, "fullImageURLs":[ ], "variantValuesOrder":{ }, "derivedListPriceFrom":"defaultPriceGroup", "repositoryId":"Sku_19Dxy", "shippingSurcharge":null, "partNumber":"part-001", "listPrice":12.99, "configurable":false }, { "dynamicPropertyMapLong":{ }, "largeImage":null, "smallImage":null, "listVolumePrice":null, "listPrices":null, "configurationMetadata":[ ], "largeImageURLs":[ ], "productLine":null, "listVolumePrices":null, "derivedSalePriceFrom":"defaultPriceGroup", "model":null, "id":"Sku_19Dxyi", "barcode":"200000000141", "salePriceEndDate":null, "images":[ ], "unitOfMeasure":null, "primaryMediumImageURL":null, "dynamicPropertyMapBigString":{ }, "active":true, "thumbImageURLs":[ ], "mediumImageURLs":[ ], "primarySourceImageURL":null, "primarySmallImageURL":null, "sourceImageURLs":[ ], "productFamily":null, "primaryThumbImageURL":null, "nonreturnable":false, "displayName":null, "salePrices":null, "primaryFullImageURL":null, "productListingSku":null, "primaryLargeImageURL":null, "derivedOnlineOnly":true, "derivedShippingSurchargeFrom":"defaultPriceGroup", "smallImageURLs":[ ], "shippingSurcharges":{ "defaultPriceGroup":null }, "thumbnailImage":null, "saleVolumePrices":null, "saleVolumePrice":null, "salePriceStartDate":null, "quantity":15, "salePrice":null, "fullImageURLs":[ ], "variantValuesOrder":{ }, "derivedListPriceFrom":"defaultPriceGroup", "repositoryId":"Sku_19Dxyi", "shippingSurcharge":null, "partNumber":"part-001", "listPrice":null, "configurable":false }, { "dynamicPropertyMapLong":{ }, "largeImage":null, "smallImage":null, "listVolumePrice":null, "listPrices":null, "configurationMetadata":[ ], "largeImageURLs":[ ], "productLine":null, "listVolumePrices":null, "derivedSalePriceFrom":"defaultPriceGroup", "model":null, "id":"Sku_19Dxyii", "barcode":"200000000158", "salePriceEndDate":null, "images":[ ], "unitOfMeasure":null, "primaryMediumImageURL":null, "dynamicPropertyMapBigString":{ }, "active":true, "thumbImageURLs":[ ], "mediumImageURLs":[ ], "primarySourceImageURL":null, "primarySmallImageURL":null, "sourceImageURLs":[ ], "productFamily":null, "primaryThumbImageURL":null, "nonreturnable":false, "displayName":null, "salePrices":null, "primaryFullImageURL":null, "productListingSku":null, "primaryLargeImageURL":null, "derivedShippingSurchargeFrom":"defaultPriceGroup", "smallImageURLs":[ ], "shippingSurcharges":{ "defaultPriceGroup":null }, "thumbnailImage":null, "saleVolumePrices":null, "saleVolumePrice":null, "salePriceStartDate":null, "quantity":15, "salePrice":8.99, "fullImageURLs":[ ], "variantValuesOrder":{ }, "derivedListPriceFrom":"defaultPriceGroup", "repositoryId":"Sku_19Dxyii", "shippingSurcharge":null, "partNumber":"part-001", "listPrice":19.99, "configurable":false } ], "childSKUs":[ { "dynamicPropertyMapLong":{ }, "largeImage":null, "smallImage":null, "listVolumePrice":null, "listPrices":null, "configurationMetadata":[ ], "largeImageURLs":[ ], "productLine":null, "listVolumePrices":null, "derivedSalePriceFrom":"defaultPriceGroup", "model":null, "id":"Sku_19Dxy", "barcode":"200000000134", "salePriceEndDate":null, "images":[ ], "unitOfMeasure":null, "primaryMediumImageURL":null, "dynamicPropertyMapBigString":{ }, "active":true, "thumbImageURLs":[ ], "mediumImageURLs":[ ], "primarySourceImageURL":null, "primarySmallImageURL":null, "sourceImageURLs":[ ], "productFamily":null, "primaryThumbImageURL":null, "nonreturnable":false, "displayName":null, "salePrices":null, "primaryFullImageURL":null, "productListingSku":null, "primaryLargeImageURL":null, "derivedOnlineOnly":false, "derivedShippingSurchargeFrom":"defaultPriceGroup", "smallImageURLs":[ ], "shippingSurcharges":{ "defaultPriceGroup":null }, "thumbnailImage":null, "saleVolumePrices":null, "saleVolumePrice":null, "salePriceStartDate":null, "quantity":15, "salePrice":4.99, "fullImageURLs":[ ], "derivedListPriceFrom":"defaultPriceGroup", "repositoryId":"Sku_19Dxy", "shippingSurcharge":null, "partNumber":"part-001", "listPrice":12.99, "configurable":false }, { "productFamily":null, "dynamicPropertyMapLong":{ }, "primaryThumbImageURL":null, "largeImage":null, "smallImage":null, "listVolumePrice":null, "nonreturnable":false, "displayName":null, "salePrices":null, "primaryFullImageURL":null, "listPrices":null, "configurationMetadata":[ ], "productListingSku":null, "largeImageURLs":[ ], "productLine":null, "listVolumePrices":null, "primaryLargeImageURL":null, "derivedShippingSurchargeFrom":"defaultPriceGroup", "smallImageURLs":[ ], "derivedSalePriceFrom":"defaultPriceGroup", "shippingSurcharges":{ "defaultPriceGroup":null }, "model":null, "id":"Sku_19Dxyi", "thumbnailImage":null, "barcode":"200000000141", "saleVolumePrices":null, "salePriceEndDate":null, "saleVolumePrice":null, "salePriceStartDate":null, "images":[ ], "quantity":15, "unitOfMeasure":null, "salePrice":null, "primaryMediumImageURL":null, "fullImageURLs":[ ], "dynamicPropertyMapBigString":{ }, "active":true, "thumbImageURLs":[ ], "mediumImageURLs":[ ], "derivedListPriceFrom":"defaultPriceGroup", "repositoryId":"Sku_19Dxyi", "shippingSurcharge":null, "primarySourceImageURL":null, "partNumber":"part-001", "primarySmallImageURL":null, "sourceImageURLs":[ ], "listPrice":null, "configurable":false }, { "productFamily":null, "dynamicPropertyMapLong":{ }, "primaryThumbImageURL":null, "largeImage":null, "smallImage":null, "listVolumePrice":null, "nonreturnable":false, "displayName":null, "salePrices":null, "primaryFullImageURL":null, "listPrices":null, "configurationMetadata":[ ], "productListingSku":null, "largeImageURLs":[ ], "productLine":null, "listVolumePrices":null, "primaryLargeImageURL":null, "derivedShippingSurchargeFrom":"defaultPriceGroup", "smallImageURLs":[ ], "derivedSalePriceFrom":"defaultPriceGroup", "shippingSurcharges":{ "defaultPriceGroup":null }, "model":null, "id":"Sku_19Dxyii", "thumbnailImage":null, "barcode":"200000000158", "saleVolumePrices":null, "salePriceEndDate":null, "saleVolumePrice":null, "salePriceStartDate":null, "images":[ ], "quantity":15, "unitOfMeasure":null, "salePrice":8.99, "primaryMediumImageURL":null, "fullImageURLs":[ ], "dynamicPropertyMapBigString":{ }, "active":true, "thumbImageURLs":[ ], "mediumImageURLs":[ ], "derivedListPriceFrom":"defaultPriceGroup", "repositoryId":"Sku_19Dxyii", "shippingSurcharge":null, "primarySourceImageURL":null, "partNumber":"part-001", "primarySmallImageURL":null, "sourceImageURLs":[ ], "listPrice":19.99, "configurable":false } ], "lastModifiedDate":"2023-01-31T05:10:45.075Z", "salePrice":8.99, "primaryMediumImageURL":"/ccstore/v1/images/?source=/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg&height=475&width=475", "fullImageURLs":[ "/ccstore/v1/images/?source=/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg" ], "active":true, "thumbImageURLs":[ "/ccstore/v1/images/?source=/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg&height=100&width=100" ], "productImages":[ { "path":"/products/sixteen_candles_LARGE.jpg", "metadata":{ }, "repositoryId":"m470131", "name":"16 Candles Image - Large", "url":"http://localhost:9080/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg", "tags":[ ] } ], "variantValuesOrder":{ }, "route":"/16-candles/product/Product_19Cxy", "notForIndividualSale":false, "mediumImageURLs":[ "/ccstore/v1/images/?source=/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg&height=475&width=475" ], "derivedListPriceFrom":"defaultPriceGroup", "repositoryId":"Product_19Cxy", "shippingSurcharge":null, "primarySourceImageURL":"/ccstore/v1/images/?source=/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg&height=300&width=300", "partNumber":"MOV-SWEET16-MOV001", "primarySmallImageURL":"/ccstore/v1/images/?source=/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg&height=300&width=300", "sourceImageURLs":[ "/ccstore/v1/images/?source=/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg&height=300&width=300" ], "minOrderLimit":1, "avgCustRating":4.5, "listPrice":19.99, "configurable":false }, { "longDescription":null, "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg&height=100&width=100", "largeImage":null, "smallImage":null, "nonreturnable":false, "displayName":"Absurdistan", "orderLimit":100, "description":"Not really serious", "listPrices":null, "salePrices":null, "primaryFullImageURL":"/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg", "type":null, "largeImageURLs":[ "/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg&height=940&width=940" ], "primaryLargeImageURL":"/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg&height=940&width=940", "smallImageURLs":[ "/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg&height=300&width=300" ], "derivedShippingSurchargeFrom":"defaultPriceGroup", "derivedSalePriceFrom":"defaultPriceGroup", "shippingSurcharges":{ "defaultPriceGroup":null }, "id":"Product_11D", "filteredSKUs":[ { "dynamicPropertyMapLong":{ }, "largeImage":null, "smallImage":null, "listVolumePrice":null, "listPrices":null, "configurationMetadata":[ ], "largeImageURLs":[ ], "productLine":null, "listVolumePrices":null, "derivedSalePriceFrom":"defaultPriceGroup", "model":null, "id":"Sku_11E", "barcode":"200000000028", "salePriceEndDate":null, "images":[ ], "unitOfMeasure":null, "primaryMediumImageURL":null, "dynamicPropertyMapBigString":{ }, "active":true, "thumbImageURLs":[ ], "mediumImageURLs":[ ], "primarySourceImageURL":null, "primarySmallImageURL":null, "sourceImageURLs":[ ], "productFamily":null, "primaryThumbImageURL":null, "nonreturnable":false, "displayName":null, "salePrices":null, "primaryFullImageURL":null, "productListingSku":null, "primaryLargeImageURL":null, "derivedOnlineOnly":true, "smallImageURLs":[ ], "derivedShippingSurchargeFrom":"defaultPriceGroup", "shippingSurcharges":{ "defaultPriceGroup":null }, "thumbnailImage":null, "saleVolumePrices":null, "saleVolumePrice":null, "salePriceStartDate":null, "quantity":3, "salePrice":10.99, "fullImageURLs":[ ], "variantValuesOrder":{ }, "repositoryId":"Sku_11E", "derivedListPriceFrom":"defaultPriceGroup", "shippingSurcharge":null, "partNumber":"part-001", "listPrice":19.99, "configurable":false } ], "childSKUs":[ { "productFamily":null, "dynamicPropertyMapLong":{ }, "primaryThumbImageURL":null, "largeImage":null, "smallImage":null, "listVolumePrice":null, "nonreturnable":false, "displayName":null, "salePrices":null, "primaryFullImageURL":null, "listPrices":null, "configurationMetadata":[ ], "productListingSku":null, "largeImageURLs":[ ], "productLine":null, "listVolumePrices":null, "primaryLargeImageURL":null, "derivedOnlineOnly":false, "smallImageURLs":[ ], "derivedShippingSurchargeFrom":"defaultPriceGroup", "derivedSalePriceFrom":"defaultPriceGroup", "shippingSurcharges":{ "defaultPriceGroup":null }, "model":null, "id":"Sku_11E", "thumbnailImage":null, "barcode":"200000000028", "saleVolumePrices":null, "salePriceEndDate":null, "saleVolumePrice":null, "salePriceStartDate":null, "images":[ ], "quantity":3, "unitOfMeasure":null, "salePrice":10.99, "primaryMediumImageURL":null, "fullImageURLs":[ ], "dynamicPropertyMapBigString":{ }, "active":true, "thumbImageURLs":[ ], "mediumImageURLs":[ ], "repositoryId":"Sku_11E", "derivedListPriceFrom":"defaultPriceGroup", "primarySourceImageURL":null, "shippingSurcharge":null, "primarySmallImageURL":null, "sourceImageURLs":[ ], "listPrice":19.99, "configurable":false } ], "lastModifiedDate":"2023-01-31T05:10:45.075Z", "salePrice":null, "primaryMediumImageURL":"/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg&height=475&width=475", "fullImageURLs":[ "/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg" ], "active":true, "thumbImageURLs":[ "/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg&height=100&width=100" ], "productImages":[ { "path":"/products/absurdistan_LARGE.jpg", "metadata":{ }, "repositoryId":"m470133", "name":"Absurdistan Image - Large", "url":"http://localhost:9080/file/v4248266855026120653/products/absurdistan_LARGE.jpg", "tags":[ ] } ], "variantValuesOrder":{ }, "route":"/absurdistan/product/Product_11D", "notForIndividualSale":false, "mediumImageURLs":[ "/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg&height=475&width=475" ], "repositoryId":"Product_11D", "derivedListPriceFrom":"defaultPriceGroup", "primarySourceImageURL":"/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg&height=300&width=300", "shippingSurcharge":null, "partNumber":"MOV-SWEET16-MOV001", "primarySmallImageURL":"/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg&height=300&width=300", "sourceImageURLs":[ "/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg&height=300&width=300" ], "minOrderLimit":1, "avgCustRating":4, "listPrice":19.99, "configurable":false }, { "longDescription":"Akira isn???t just a movie ??? it???s the genesis of a genre. Katsuhiro\n Otomo???s landmark cyberpunk classic obliterated the boundaries of Japanese animation and forced the world\n to look into the future. Akira???s arrival shattered traditional thinking, creating space for movies like\n the The Matrix to be dreamed into brutal reality. Without Kaneda and Tetsuo, without espers and psionic\n assassins, without that badass motorcycle ??? our world would be a far less exciting place to exist. But\n the manga became the movie and the movie became a phenomenon and the world took notice. Now, Akira is\n everywhere. If you can???t see it in the streets ??? if you can???t feel it crawling around inside your brain\n ??? then you have yet to be initiated. What. Are. You. Waiting. For?\n ", "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=100&width=100", "largeImage":null, "smallImage":null, "nonreturnable":false, "displayName":"Akira", "orderLimit":null, "description":"A really great movie that you should not miss.", "listPrices":null, "salePrices":null, "primaryFullImageURL":"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg", "type":null, "largeImageURLs":[ "/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=940&width=940" ], "primaryLargeImageURL":"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=940&width=940", "smallImageURLs":[ "/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=300&width=300" ], "derivedShippingSurchargeFrom":"defaultPriceGroup", "derivedSalePriceFrom":"defaultPriceGroup", "shippingSurcharges":{ "defaultPriceGroup":null }, "id":"Product_27Fxyzi", "filteredSKUs":[ { "productFamily":null, "dynamicPropertyMapLong":{ }, "primaryThumbImageURL":null, "largeImage":null, "smallImage":null, "listVolumePrice":null, "nonreturnable":false, "displayName":null, "salePrices":null, "primaryFullImageURL":null, "listPrices":null, "configurationMetadata":[ ], "productListingSku":null, "largeImageURLs":[ ], "productLine":null, "listVolumePrices":null, "primaryLargeImageURL":null, "derivedOnlineOnly":true, "smallImageURLs":[ ], "derivedShippingSurchargeFrom":"defaultPriceGroup", "shippingSurcharges":{ "defaultPriceGroup":null }, "model":null, "id":"Sku_27Gxyzi", "thumbnailImage":null, "barcode":"200000000295", "saleVolumePrices":null, "salePriceEndDate":null, "saleVolumePrice":null, "salePriceStartDate":null, "images":[ ], "quantity":7, "unitOfMeasure":null, "salePrice":null, "primaryMediumImageURL":null, "fullImageURLs":[ ], "dynamicPropertyMapBigString":{ }, "active":true, "thumbImageURLs":[ ], "variantValuesOrder":{ }, "mediumImageURLs":[ ], "repositoryId":"Sku_27Gxyzi", "derivedListPriceFrom":"defaultPriceGroup", "primarySourceImageURL":null, "shippingSurcharge":null, "primarySmallImageURL":null, "sourceImageURLs":[ ], "listPrice":24.99, "configurable":false } ], "childSKUs":[ { "productFamily":null, "dynamicPropertyMapLong":{ }, "primaryThumbImageURL":null, "largeImage":null, "smallImage":null, "listVolumePrice":null, "nonreturnable":false, "displayName":null, "salePrices":null, "primaryFullImageURL":null, "listPrices":null, "configurationMetadata":[ ], "productListingSku":null, "largeImageURLs":[ ], "productLine":null, "listVolumePrices":null, "primaryLargeImageURL":null, "derivedOnlineOnly":false, "smallImageURLs":[ ], "derivedShippingSurchargeFrom":"defaultPriceGroup", "shippingSurcharges":{ "defaultPriceGroup":null }, "model":null, "id":"Sku_27Gxyzi", "thumbnailImage":null, "barcode":"200000000295", "saleVolumePrices":null, "salePriceEndDate":null, "saleVolumePrice":null, "salePriceStartDate":null, "images":[ ], "quantity":7, "unitOfMeasure":null, "salePrice":null, "primaryMediumImageURL":null, "fullImageURLs":[ ], "dynamicPropertyMapBigString":{ }, "active":true, "thumbImageURLs":[ ], "mediumImageURLs":[ ], "repositoryId":"Sku_27Gxyzi", "derivedListPriceFrom":"defaultPriceGroup", "primarySourceImageURL":null, "shippingSurcharge":null, "primarySmallImageURL":null, "sourceImageURLs":[ ], "listPrice":24.99, "configurable":false } ], "lastModifiedDate":"2023-01-31T05:10:45.075Z", "salePrice":null, "primaryMediumImageURL":"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=475&width=475", "fullImageURLs":[ "/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg" ], "active":true, "thumbImageURLs":[ "/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=100&width=100" ], "productImages":[ { "path":"/products/akira_LARGE.jpg", "metadata":{ }, "repositoryId":"m540123", "name":"Akira Image - Large", "url":"http://localhost:9080/file/v291840211342511571/products/akira_LARGE.jpg", "tags":[ ] } ], "variantValuesOrder":{ }, "route":"/akira/product/Product_27Fxyzi", "notForIndividualSale":false, "mediumImageURLs":[ "/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=475&width=475" ], "repositoryId":"Product_27Fxyzi", "derivedListPriceFrom":"defaultPriceGroup", "primarySourceImageURL":"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=300&width=300", "shippingSurcharge":null, "partNumber":"MOV-AKIRA-CYB001", "primarySmallImageURL":"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=300&width=300", "sourceImageURLs":[ "/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=300&width=300" ], "minOrderLimit":1, "avgCustRating":4.5, "listPrice":24.99, "configurable":false } ] } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|30015|SiteId passed in x-ccsite header is currently inactive|\n|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|\n|20034|Get ProductList Internal Error|\n|25013|price List InternalError|\n|20041|Null ProductListingRequest argument passed to method|\n|20040|Get Product Type Internal Error|\n|10002|Invalid value [ {1} ] for parameter: {0}.|\n" } }, "parameters":[ { "in":"query", "name":"catalogId", "description":"ID of the catalog. If a catalogId is not passed, the catalog associated with the shopperProfileId passed in the X-CCAgentContext header is used. If no shopperProfileId is passed in the header, default catalog associated with the site is used.", "type":"string", "required":false }, { "in":"query", "name":"secondaryCurrencyCode", "description":"In case of mix currency, if secondaryCurrencyCode is getting passed, secondaryCurrencyShippingSurcharge will be calculated according to secondaryCurrencyCode", "type":"string", "required":false }, { "in":"query", "name":"showInactiveSkus", "description":"Return inactive skus only if its value is true", "type":"boolean", "required":false }, { "in":"query", "name":"showTranslations", "description":"Boolean indicating if the translations property should be returned for each item in the response.", "type":"boolean", "required":false }, { "in":"query", "name":"productIds", "description":"Product IDs to list.", "type":"string", "required":false }, { "in":"query", "name":"name", "description":"Partial displayName of a product to use for search.", "type":"string", "required":false }, { "in":"query", "name":"continueOnMissingProduct", "description":"boolean flag to determine whether to continue if a product is missing.", "type":"string", "required":false }, { "in":"query", "name":"showQuantity", "description":"Show inventory quantity.", "type":"string", "required":false }, { "in":"query", "name":"unassigned", "description":"Restrict response to unassigned products (ignore categoryId).", "type":"string", "required":false }, { "in":"query", "name":"verifyCatalog", "description":"Boolean flag to determine whether to verify if a product belongs to the current catalog.", "type":"boolean", "required":false }, { "in":"query", "name":"categoryId", "description":"Restrict the response to just products in the given category id.", "type":"string", "required":false }, { "in":"query", "name":"includeChildSKUsListingIds", "description":"Boolean indicating whether the child SKU listing ID is required to included or not.", "type":"boolean", "required":false }, { "in":"query", "name":"storePriceListGroupId", "description":"the price list group id for which product prices are to be returned", "type":"string", "required":false }, { "in":"header", "name":"x-ccsite", "description":"the site id on which the orders is laced", "type":"string", "required":false } ], "tags":[ "Agent/Products" ], "x-internal-id":"ccagent-v1-products-get", "x-filename-id":"ccagent-v1-products-get" } }, "/ccagent/v1/profileRequests/{id}/approve":{ "post":{ "summary":"Approve profile request", "produces":[ "application/json" ], "operationId":"approveProfileRequest", "description":"Approve profile request endpoint. This operation is used to approve profile request in Oracle Commerce Cloud.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/approveProfileRequest_response" }, "examples":{ "application/json":{ "id":"100001", "status":"approved" } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|102000|Invalid Profile Request ID.|\n|10001|Organization ID is required.|\n|101008|This operation is not allowed as registration request is already in approved/rejected state.|\n|100091|Agent does not have permission to perform this action.|\n|89101|If the shopperProfile passed in the AgentContext header is not an administrator for the account" } }, "parameters":[ { "in":"path", "name":"id", "description":"The ID of the Profile request.", "type":"string", "required":true }, { "in":"header", "name":"X-CCAgentContext", "description":"The Agent Context is a JSON object with shopperProfileId as a property.", "type":"string", "required":true }, { "in":"header", "name":"X-CCOrganization", "description":"The organization Id associated with the shopper profile", "type":"string", "required":true }, { "schema":{ "$ref":"#/definitions/approveProfileRequest_request" }, "in":"body", "name":"approveProfileRequest_request" } ], "tags":[ "Agent/Profile Request" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-profileRequests-{id}-approve-post", "x-filename-id":"ccagent-v1-profilerequests-id-approve-post" } }, "/ccagent/v1/appeasements/submit":{ "post":{ "summary":"submitAppeasement", "produces":[ "application/json" ], "operationId":"submitAppeasement", "description":"Submits an Appeasement. Submits an existing appeasement if an Id is provided in the payload. Creates and submits a new appeasement altogether otherwise. Custom properties are supported directly at both appeasement level and each appeasementRefund level.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/submitAppeasement_response" }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|900000|When an internal error occurs|\n|13001|When the input is invalid|\n|900015|When an internal error occurs with the appeasementValidation webhook|\n|900016|When the appeasement is invalid according to the appeasementValidation webhook|\n|900017|When the invalid refundType is passed for an appeasement refund|\n|900001|If an internal error occurs with the repository|\n|900002|When the given appeasement Id is invalid or not found|\n|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|\n" } }, "parameters":[ { "in":"header", "name":"X-CCAsset-Language", "description":"The asset language of the request. E.g., en,de,fr_CA.", "type":"string", "required":false }, { "in":"header", "name":"X-CCOrganization", "description":"The organization Id on which the appeasement is being submitted. ", "type":"string", "required":false }, { "in":"header", "name":"X-CCSite", "description":"The site Id on which the appeasement is being submitted.", "type":"string", "required":false }, { "schema":{ "$ref":"#/definitions/submitAppeasement_request" }, "in":"body", "name":"submitAppeasement_request" } ], "tags":[ "Agent/Appeasement" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-appeasements-submit-post", "x-filename-id":"ccagent-v1-appeasements-submit-post" } }, "/ccagent/v1/openid/logoutRequest":{ "get":{ "summary":"get OpenID logout request", "produces":[ "application/json" ], "operationId":"getOpenIDLogoutRequest", "description":"Get OpenID logout request", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getOpenIDLogoutRequest_response" }, "examples":{ "application/json":{ "openid_logout_request_dst":"https://cx-tenant02.identity.example.com/oauth2/v1/userlogout" } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|52301|Internal Error.|\n" } }, "tags":[ "Agent/OpenID" ], "x-internal-id":"ccagent-v1-openid-logoutRequest-get", "x-filename-id":"ccagent-v1-openid-logoutrequest-get" } }, "/ccagent/v1/orderAmendments/{orderId}":{ "post":{ "summary":"handleOrderAmendment", "produces":[ "application/json" ], "operationId":"handleOrderAmendment", "description":"Handle Order Amendment. Performs either of the operations initiateAmendment(initiates the order amendment process), checkAmendmentInProgress, priceOrderAmendmentcheck by passing op value. Additonally takes x-ccsite header to submit the edited order in a site. If the site information is not provided takes the order site. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/handleOrderAmendment_response" }, "examples":{ "application/json":{ "originalOrderId":"o160415", "pricingMessages":{ "promotionUpsellMessages":[ { "text":"Spend $20 more get free shipping!", "tags":[ "CART_UPSELL" ] }, { "text":"You have qualified for a free Sports DVD!", "tags":[ "BANNER_UPSELL", "CART_UPSELL" ] } ] }, "orderableQuantityMap":{ "camcorder_1:camcordersku_1_3":5 }, "priceOverrideReasons":[ { "displayValue":"Agent Price Override", "key":"agentPriceOverride" }, { "displayValue":"Appeasement", "key":"appeasement" } ], "isItemPriceOverrideAllowed":true, "links":[ { "rel":"self", "href":"http://localhost:9080/ccagentui/v1/orderAmendments/o160415" } ], "cloneOrder":{ "totalAmountAuthorized":542.8, "orderComments":[ ], "creationTime":"1465930276000", "dynamicProperties":[ ], "paymentGroups":[ { "lastName":"test", "amountAuthorized":542.8, "amount":542.8, "totalDue":542.8, "cardType":null, "type":"card", "token":"9997000108950573", "paymentGroupId":"pg160420", "firstName":"Test", "paymentStateDetailsAsUser":"The authorization succeeded", "uiIntervention":"sop", "billingAddress":{ "lastName":"test", "country":"US", "address3":null, "address2":null, "city":"tt", "address1":"t", "prefix":null, "companyName":null, "postalCode":"13202", "jobTitle":null, "county":null, "suffix":null, "firstName":"Test", "phoneNumber":"222-333-1111", "stateName":"New York", "faxNumber":null, "middleName":null, "countryName":"United States", "state":"NY", "email":"test@example.com" }, "paymentState":1, "paidAmount":0, "cardNumber":"xxxxxxxxxxxx1111", "refundAmount":0 } ], "submittedDate":"2016-06-14T19:06:37.000Z", "priceInfo":{ "amount":467.6, "total":542.8, "shipping":35, "shippingSurchargeValue":0, "tax":40.2, "subTotal":597, "currencyCode":"USD", "totalWithoutTax":502.6 }, "paymentGroup":{ "lastName":"test", "amountAuthorized":542.8, "amount":542.8, "totalDue":542.8, "cardType":null, "type":"card", "token":"9997000108950573", "paymentGroupId":"pg160420", "firstName":"Test", "paymentStateDetailsAsUser":"The authorization succeeded", "uiIntervention":"sop", "billingAddress":{ "lastName":"test", "country":"US", "address3":null, "address2":null, "city":"tt", "address1":"t", "prefix":null, "companyName":null, "postalCode":"13202", "jobTitle":null, "county":null, "suffix":null, "firstName":"Test", "phoneNumber":"222-333-1111", "stateName":"New York", "faxNumber":null, "middleName":null, "countryName":"United States", "state":"NY", "email":"test@example.com" }, "paymentState":1, "paidAmount":0, "cardNumber":"xxxxxxxxxxxx1111", "refundAmount":0 }, "shoppingCart":{ "items":[ { "deactivationDate":"2018-06-27T12:59:59Z", "rawTotalPrice":699.99, "returnedQuantity":0, "priceOverridenBy":"", "dynamicProperties":[ { "id":"ReferralCode", "label":"ReferralCode", "value":null }, { "id":"OfferEndsDate", "label":"OfferEndsDate", "value":"2020-07-02T03:42:42.962Z" }, { "id":"Discount", "label":"Discount", "value":10 }, { "id":"GiftWrapping", "label":"Gift Wrapping", "value":false }, { "id":"name", "label":"Name on product(Mug)", "value":"My name" } ], "displayName":"Samsung - F90BN HD Flash Memory Camcorder", "shippingSurchargeValue":0, "externalData":[ ], "billingProfileId":"billingProfile-123", "discountAmount":0, "billingAccountId":"billingAcc-123", "imageInfo":{ "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v2/products/Samsung_F90BN_LARGE.jpg&height=100&width=100" }, "childItems":[ { "serviceAccountId":"serviceAcc-123", "configurationOptionId":"co40001", "deactivationDate":"2018-06-27T12:59:59Z", "quantity":1, "productId":"prod40001", "displayName":"Intel Pentium Dual Core", "isAddOnItem":true, "externalData":[ ], "parentAssetKey":"12345", "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "rootAssetKey":"12345", "configurablePropertyId":"cp40001", "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"sku40001", "assetKey":"23456", "commerceItemId":"ci19000424", "route":"/intel-pentium-dual-core/product/prod40001", "customerAccountId":"customerAcc-123", "selectedOptions":[ ], "actionCode":"Add", "activationDate":"2017-06-27T15:30:00Z", "serviceId":"service-123", "asset":false }, { "serviceAccountId":"serviceAcc-123", "deactivationDate":"2018-06-27T12:59:59Z", "quantity":1, "productId":"prod40007", "displayName":"8 GB Kingston Sodimm DDR3 1600MHz", "isAddOnItem":false, "externalData":[ ], "parentAssetKey":"12345", "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "childItems":[ { "serviceAccountId":"serviceAcc-123", "deactivationDate":"2018-06-27T12:59:59Z", "quantity":1, "productId":"prod40009", "displayName":"Intel Pentium i9 Core", "externalData":[ ], "parentAssetKey":"12345", "billingAccountId":"billingAcc-123", "rootAssetKey":"98765", "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"sku40009", "assetKey":"84848", "route":"/intel-pentium-dual-core/product/prod40001", "customerAccountId":"customerAcc-123", "selectedOptions":[ ], "actionCode":"Add", "activationDate":"2017-06-27T15:30:00Z", "serviceId":"service-123", "asset":false } ], "rootAssetKey":"12345", "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"sku40007", "assetKey":"98765", "commerceItemId":"ci19000425", "route":"/8-gb-kingston-sodimm-ddr3-1600mhz/product/prod40007", "customerAccountId":"customerAcc-123", "selectedOptions":[ ], "actionCode":"Add", "activationDate":"2017-06-27T15:30:00Z", "serviceId":"service-123", "asset":false } ], "configuratorId":"36379716", "assetKey":"12345", "overriddenPrice":"", "commerceItemId":"ci1000785", "price":597, "isPriceOverridden":false, "variant":[ { "optionValue":"Neon", "optionName":"color" }, { "optionValue":"2x optical/130x digital", "optionName":"zoom" } ], "actionCode":"Add", "serviceId":"service-123", "stateDetailsAsUser":"Added to order", "serviceAccountId":"serviceAcc-123", "unitPrice":597, "quantity":1, "productId":"camcorder_1", "salePrice":597, "parentAssetKey":null, "tax":37.4, "rootAssetKey":null, "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"camcordersku_1_3", "customerAccountId":"customerAcc-123", "discountInfo":[ ], "activationDate":"2017-06-27T15:30:00Z", "asset":false, "listPrice":699.99, "status":0, "priceOverrideReason":{ } } ] }, "state":10, "id":"o160416", "quoteInfo":{ "providerNote":null, "notes":[ { "providerDate":"2016-11-25T13:33:48.000Z", "providerNote":"The quote is approved as per the request", "profileType":null, "profileId":"se-570031" }, { "profileType":null, "profileId":"se-570031", "requestDate":"2016-10-25T13:33:48.000Z", "requesterNote":"provide 10 percent off on the total quantity" } ], "rejectionDate":null, "requestDate":"2016-10-25T13:33:48.000Z", "errorInfo":null, "externalID":null, "rejectionNote":null, "quoteDate":"2016-10-25T13:35:32.000Z", "expirationDate":"2026-04-28T18:53:48.000Z" }, "stateDetailsAsUser":"Order being amended", "taxPriceInfo":{ "cityTax":0, "amount":40.2, "valueAddedTax":0, "countyTax":20.099999999999998, "isTaxIncluded":false, "miscTax":0, "districtTax":0, "stateTax":20.099999999999998, "countryTax":0 }, "shippingGroups":[ { "firstName":null, "emailAddress":null, "phoneNumber":null, "trackingInfo":[ ], "shippingMethod":{ "shippingTax":2.8, "cost":35, "displayName":"Standard", "value":"standardShippingMethod" }, "shippingAddress":{ "lastName":"test", "country":"US", "address3":null, "address2":"t", "city":"tt", "address1":"t", "prefix":null, "companyName":null, "postalCode":"13202", "jobTitle":null, "county":null, "suffix":null, "firstName":"Test", "phoneNumber":"222-333-1111", "stateName":"New York", "faxNumber":null, "middleName":null, "countryName":"United States", "state":"NY", "email":"test@example.com" }, "middleName":null, "store":{ "country":"USA", "hours":"Mon - Sat 10AM - 7PM Sun 11AM - 6 PM", "address3":null, "address2":"15th Floor", "city":"San Francisco", "address1":"475 Sansome Street", "postalCode":"94111", "county":null, "stateAddress":"CA", "phoneNumber":"(617) 386-1200", "locationId":"testLoc2", "name":"Cloud Store - SanFrancisco", "faxNumber":"(617) 386-1200", "email":"store113@example.com" }, "type":"inStorePickupShippingGroup", "items":[ { "serviceAccountId":"serviceAcc-123", "availablePickupDate":null, "deactivationDate":"2018-06-27T12:59:59Z", "quantity":1, "productId":"Product_18Cxi", "preferredPickupDate":null, "externalData":[ ], "parentAssetKey":null, "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "rootAssetKey":null, "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"Sku_18Dxi", "assetKey":"84756", "customerAccountId":"customerAcc-123", "actionCode":"Add", "activationDate":"2017-06-27T15:30:00Z", "serviceId":"service-123", "asset":false } ], "trackingNumber":null } ], "shippingMethod":{ "shippingTax":2.8, "cost":35, "displayName":"Standard", "value":"standardShippingMethod" }, "profile":{ "lastName":"test", "firstName":"Test", "middleName":null, "email":"test@example.com" }, "priceListGroup":{ "deleted":false, "displayName":"Default Price Group", "listPriceList":{ "repositoryId":"listPrices" }, "repositoryId":"defaultPriceGroup", "active":true, "salePriceList":{ "repositoryId":"salePrices" }, "currency":{ "symbol":"$", "displayName":"US Dollar", "repositoryId":"en_US", "fractionalDigits":2, "currencyCode":"USD", "numericCode":"840" }, "id":"defaultPriceGroup", "locale":"en_US", "shippingSurchargePriceList":{ "repositoryId":"shippingSurchargePrices" } }, "returnRequests":[ ], "creationDate":"2016-06-14T18:51:16.000Z", "originOfOrder":"contactCenter", "discountInfo":{ "unclaimedCouponMultiPromotions":{ }, "orderCouponsMap":{ "Coupon2":{ "promotionLevel":"order", "totalAdjustment":"-119.4", "promotionDesc":"SPEND200FOR20PercentOFF", "promotionId":"promo30007" } }, "orderDiscount":129.39999999999998, "shippingDiscount":0, "orderImplicitDiscountList":[ ], "claimedCouponMultiPromotions":{ "Coupon2":[ { "promotionLevel":"order", "totalAdjustment":"-119.4", "promotionDesc":"SPEND200FOR20PercentOFF", "promotionId":"promo30007" }, { "promotionLevel":"order", "totalAdjustment":"-10.0", "promotionDesc":"Order_Discount_M2M", "promotionId":"promo30008" } ] }, "unclaimedCouponsMap":{ } }, "orderCancelReason":null, "profileId":"120026", "exchangeRequests":[ ], "siteId":"siteUS", "shippingAddress":{ "lastName":"test", "country":"US", "address3":null, "address2":"t", "city":"tt", "address1":"t", "prefix":null, "companyName":null, "postalCode":"13202", "jobTitle":null, "county":null, "suffix":null, "firstName":"Test", "phoneNumber":"222-333-1111", "stateName":"New York", "faxNumber":null, "middleName":null, "countryName":"United States", "state":"NY", "email":"test@example.com" } } } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response. In case of any failure in external tax or external shipping webhooks, the errors returned in the webhook response payload get added to the errors property in this endpoint???s error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|200109|No edit in progress|\n|200106|Order data passed is null|\n|200105|Order id passed is null or empty|\n|200108|Edit in progress by another agent|\n|200107|Internal error occurred|\n|200110|Internal error occurred|\n|30020|The Site to which the order belongs was deleted|\n|30021|The Site to which the order belongs is currently inactive|\n|100094|Organization passed in the header is currently inactive|\n|20101|Invalid shipping details|\n|100095|The order or return request does not belong to the current organization of the shopper profile|\n|100096|The organization associated to the order or return request was deleted / does not exist|\n|100097|The organization associated to the order or return request is currently inactive|\n|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|\n|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|\n|28107|Order not found|\n|200116|Internal error occurred|\n|200119|Internal error occurred|\n|20107|Specified order does not exist|\n|200112|Internal error occurred|\n|200115|Internal error occurred|\n|200120|Edit not initiated for the order|\n|30015|SiteId passed in x-ccsite header is currently inactive|\n|200100|Internal error occurred|\n|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|\n|100101|The shopper profile does not belong to organization passed in the header|\n|30019|SiteId passed in x-ccsite header is not related to the order being worked upon|\n|28410|The structure of add-ons defined for the order is invalid|\n|28329|One of the dynamic properties is not writable by the Agent user|\n" } }, "parameters":[ { "in":"header", "name":"x-ccsite", "description":"the site id in which the orders is placed", "type":"string", "required":false }, { "in":"header", "name":"X-CCOrganization", "description":"The organization Id to which the order belongs", "type":"string", "required":false }, { "in":"path", "name":"orderId", "description":"The order id.", "type":"string", "required":true }, { "schema":{ "$ref":"#/definitions/handleOrderAmendment_request" }, "in":"body", "name":"handleOrderAmendment_request" } ], "tags":[ "Agent/Order Amendment" ], "x-internal-id":"ccagent-v1-orderAmendments-{orderId}-post", "x-filename-id":"ccagent-v1-orderamendments-orderid-post" }, "delete":{ "summary":"removeOrderAmendment", "produces":[ "application/json" ], "operationId":"removeOrderAmendment", "description":"Remove Order Amendment. Discards the order amendment process by removing the clone order.Additonally takes x-ccsite header to submit the edited order in a site. If the site information is not provided takes the order site. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/removeOrderAmendment_response" }, "examples":{ "application/json":{ "orderId":"o30413", "cancelAmendSuccess":true, "links":[ { "rel":"self", "href":"http://localhost:9080/ccagent/v1/orderAmendments/o30413" } ] } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|100094|Organization passed in the header is currently inactive|\n|100095|The order or return request does not belong to the current organization of the shopper profile|\n|100096|The organization associated to the order or return request was deleted / does not exist|\n|100097|The organization associated to the order or return request is currently inactive|\n|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|\n|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|\n|200105|Order id passed is null or empty|\n|20107|Specified order does not exist|\n|200114|Internal error occurred|\n|200120|No edit in progress to cancel|\n|30015|SiteId passed in x-ccsite header is currently inactive|\n|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|\n|30020|The Site to which the order belongs was deleted|\n|30021|The Site to which the order belongs is currently inactive|\n|100101|The shopper profile does not belong to organization passed in the header|\n|30019|SiteId passed in x-ccsite header is not related to the order being worked upon|\n" } }, "parameters":[ { "in":"header", "name":"x-ccsite", "description":"the site id in which the orders is placed", "type":"string", "required":false }, { "in":"header", "name":"X-CCOrganization", "description":"The organization Id to which the order belongs", "type":"string", "required":false }, { "in":"path", "name":"orderId", "description":"Commerce id of the order.", "type":"string", "required":true } ], "tags":[ "Agent/Order Amendment" ], "x-internal-id":"ccagent-v1-orderAmendments-{orderId}-delete", "x-filename-id":"ccagent-v1-orderamendments-orderid-delete" }, "put":{ "summary":"submitOrderAmendment", "produces":[ "application/json" ], "operationId":"submitOrderAmendment", "description":"Submit Order Amendment. Applies the changes made during amend process to the order.Additonally takes x-ccsite header to submit the edited order in a site. If the site information is not provided takes the order site. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/submitOrderAmendment_response" }, "examples":{ "application/json":{ "totalAmountAuthorized":124.18, "orderComments":[ ], "creationTime":"1447666990000", "submittedDate":"2015-07-15T09:10:15.000Z", "paymentGroups":[ { "lastName":"Anderson", "amountAuthorized":124.18, "amount":124.18, "totalDue":124.18, "cardType":null, "type":"card", "token":"9997000108950573", "paymentGroupId":"pg30411", "firstName":"Kim", "paymentStateDetailsAsUser":"The authorization succeeded", "uiIntervention":"sop", "billingAddress":{ "lastName":"Anderson", "country":"US", "address3":null, "address2":null, "city":"Syracuse", "address1":"21 Cedar Ave", "prefix":null, "companyName":null, "postalCode":"13202", "jobTitle":null, "county":null, "suffix":null, "firstName":"Kim", "phoneNumber":"212-555-1977", "stateName":"New York", "faxNumber":null, "middleName":null, "countryName":"United States", "state":"NY", "email":"kim@example.com" }, "paymentState":1, "paidAmount":0, "cardNumber":"xxxxxxxxxxxx1111", "refundAmount":0 } ], "priceInfo":{ "amount":89.98, "total":124.18, "shipping":25, "shippingSurchargeValue":0, "tax":9.2, "subTotal":89.98, "currencyCode":"USD", "totalWithoutTax":114.98 }, "pricingMessages":{ "promotionUpsellMessages":[ { "text":"Spend $20 more get free shipping!", "tags":[ "CART_UPSELL" ] }, { "text":"You have qualified for a free Sports DVD!", "tags":[ "BANNER_UPSELL", "CART_UPSELL" ] } ] }, "paymentGroup":{ "lastName":"Anderson", "amountAuthorized":124.18, "amount":124.18, "totalDue":124.18, "cardType":null, "type":"card", "token":"9997000108950573", "paymentGroupId":"pg30411", "firstName":"Kim", "paymentStateDetailsAsUser":"The authorization succeeded", "uiIntervention":"sop", "billingAddress":{ "lastName":"Anderson", "country":"US", "address3":null, "address2":null, "city":"Syracuse", "address1":"21 Cedar Ave", "prefix":null, "companyName":null, "postalCode":"13202", "jobTitle":null, "county":null, "suffix":null, "firstName":"Kim", "phoneNumber":"212-555-1977", "stateName":"New York", "faxNumber":null, "middleName":null, "countryName":"United States", "state":"NY", "email":"kim@example.com" }, "paymentState":1, "paidAmount":0, "cardNumber":"xxxxxxxxxxxx1111", "refundAmount":0 }, "shoppingCart":{ "items":[ { "deactivationDate":"2018-06-27T12:59:59Z", "rawTotalPrice":39.99, "returnedQuantity":0, "displayName":"Fable II", "shippingSurchargeValue":0, "externalData":[ ], "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "imageInfo":{ "primaryThumbImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/fableIIxbox_LARGE.jpg&height=100&width=100" }, "childItems":[ { "commerceItemId":"ci19000424", "configurationOptionId":"co40001", "quantity":1, "route":"/intel-pentium-dual-core/product/prod40001", "productId":"prod40001", "displayName":"Intel Pentium Dual Core", "isAddOnItem":true, "selectedOptions":[ ], "externalData":[ ], "actionCode":"Add", "configurablePropertyId":"cp40001", "catRefId":"sku40001" }, { "serviceAccountId":"serviceAcc-123", "deactivationDate":"2018-06-27T12:59:59Z", "quantity":1, "productId":"prod40007", "displayName":"8 GB Kingston Sodimm DDR3 1600MHz", "isAddOnItem":false, "externalData":[ ], "parentAssetKey":"12345", "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "childItems":[ { "quantity":1, "route":"/intel-pentium-dual-core/product/prod40009", "productId":"prod40009", "displayName":"Intel Pentium i9", "selectedOptions":[ ], "externalData":[ ], "actionCode":"Add", "catRefId":"sku40009" } ], "rootAssetKey":"12345", "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"sku40007", "assetKey":"93743", "commerceItemId":"ci19000425", "route":"/8-gb-kingston-sodimm-ddr3-1600mhz/product/prod40007", "customerAccountId":"customerAcc-123", "selectedOptions":[ ], "actionCode":"Add", "activationDate":"2017-06-27T15:30:00Z", "serviceId":"service-123", "asset":false } ], "configuratorId":"36379716", "assetKey":"12345", "commerceItemId":"ci1000785", "price":39.99, "variant":[ ], "onSale":"true", "actionCode":"Add", "serviceId":"service-123", "stateDetailsAsUser":"The item has been initialized", "unitPrice":39.99, "serviceAccountId":"serviceAcc-123", "quantity":1, "productId":"prod10041", "parentAssetKey":null, "tax":4.08, "rootAssetKey":null, "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"sku10045", "customerAccountId":"customerAcc-123", "discountInfo":[ ], "activationDate":"2017-06-27T15:30:00Z", "asset":false, "listPrice":39.99, "status":0 }, { "unitPrice":49.99, "quantity":1, "productId":"Product_21Cxi", "rawTotalPrice":49.99, "returnedQuantity":0, "displayName":"Dora the Explorer - Season 1", "shippingSurchargeValue":0, "imageInfo":{ "primaryThumbImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/doratheexplorer_season1_LARGE.jpg&height=100&width=100" }, "tax":5.11, "catRefId":"Sku_21Dxy", "discountInfo":[ ], "price":49.99, "variant":[ ], "stateDetailsAsUser":"The item has been initialized", "listPrice":49.99, "status":0 } ] }, "links":[ { "rel":"self", "href":"http://localhost:9080/ccagent/v1/orderAmendments/o10411" } ], "state":1, "id":"o10411", "quoteInfo":{ "providerNote":null, "notes":[ { "providerDate":"2016-11-25T13:33:48.000Z", "providerNote":"The quote is approved as per the request", "profileType":null, "profileId":"se-570031" }, { "profileType":null, "profileId":"se-570031", "requestDate":"2016-10-25T13:33:48.000Z", "requesterNote":"provide 10 percent off on the total quantity" } ], "rejectionDate":null, "requestDate":"2016-10-25T13:33:48.000Z", "errorInfo":null, "externalID":null, "rejectionNote":null, "quoteDate":"2016-10-25T13:35:32.000Z", "expirationDate":"2026-04-28T18:53:48.000Z" }, "stateDetailsAsUser":"Submitted to fulfillment", "taxPriceInfo":{ "cityTax":0, "amount":9.2, "valueAddedTax":0, "countyTax":4.6, "isTaxIncluded":false, "miscTax":0, "districtTax":0, "stateTax":4.6, "countryTax":0 }, "shippingGroups":[ { "trackingInfo":[ ], "shippingMethod":{ "cost":25, "displayName":"Standard", "value":"standardShippingMethod" }, "shippingAddress":{ "lastName":"Anderson", "country":"US", "address3":null, "address2":null, "city":"Syracuse", "address1":"21 Cedar Ave", "prefix":null, "companyName":null, "postalCode":"13202", "jobTitle":null, "county":null, "suffix":null, "firstName":"Kim", "phoneNumber":"212-555-1977", "stateName":"New York", "faxNumber":null, "middleName":null, "countryName":"United States", "state":"NY", "email":"kim@example.com" }, "trackingNumber":null } ], "approvalSystemMessages":[ ], "shippingMethod":{ "cost":25, "displayName":"Standard", "value":"standardShippingMethod" }, "profile":{ "lastName":"Anderson", "firstName":"Kim", "middleName":null, "email":"kim@example.com" }, "returnRequests":[ ], "creationDate":"2015-07-15T09:09:15.000Z", "originOfOrder":"contactCenter", "discountInfo":{ "unclaimedCouponMultiPromotions":{ }, "orderCouponsMap":{ }, "orderDiscount":0, "shippingDiscount":0, "orderImplicitDiscountList":[ ], "unclaimedCouponsMap":{ }, "claimedCouponMultiPromotions":{ } }, "profileId":"se-570031", "exchangeRequests":[ ], "shippingAddress":{ "lastName":"Anderson", "country":"US", "address3":null, "address2":null, "city":"Syracuse", "address1":"21 Cedar Ave", "prefix":null, "companyName":null, "postalCode":"13202", "jobTitle":null, "county":null, "suffix":null, "firstName":"Kim", "phoneNumber":"212-555-1977", "stateName":"New York", "faxNumber":null, "middleName":null, "countryName":"United States", "state":"NY", "email":"kim@example.com" } } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|100094|Organization passed in the header is currently inactive|\n|100095|The order or return request does not belong to the current organization of the shopper profile|\n|100096|The organization associated to the order or return request was deleted / does not exist|\n|100097|The organization associated to the order or return request is currently inactive|\n|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|\n|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|\n|200105|Order id passed is null or empty|\n|200119|Internal error occurred|\n|200113|Internal error occurred|\n|20107|Specified order does not exist|\n|200120|Edit not initiated for the order|\n|30015|SiteId passed in x-ccsite header is currently inactive|\n|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|\n|30020|The Site to which the order belongs was deleted|\n|30021|The Site to which the order belongs is currently inactive|\n|100101|The shopper profile does not belong to organization passed in the header|\n|30019|SiteId passed in x-ccsite header is not related to the order being worked upon|\n|28410|The structure of add-ons defined for the order is invalid|\n|28329|One of the dynamic properties is not writable by the Agent user|\n" } }, "parameters":[ { "in":"header", "name":"x-ccsite", "description":"the site id in which the orders is placed", "type":"string", "required":false }, { "in":"header", "name":"X-CCOrganization", "description":"The organization Id to which the order belongs", "type":"string", "required":false }, { "in":"path", "name":"orderId", "description":"Commerce id of the order.", "type":"string", "required":true }, { "schema":{ "$ref":"#/definitions/submitOrderAmendment_request" }, "in":"body", "name":"submitOrderAmendment_request" } ], "tags":[ "Agent/Order Amendment" ], "x-internal-id":"ccagent-v1-orderAmendments-{orderId}-put", "x-filename-id":"ccagent-v1-orderamendments-orderid-put" } }, "/ccagent/v1/profiles/{id}/siteProperties":{ "get":{ "summary":"listSiteProperties", "produces":[ "application/json" ], "operationId":"listSiteProperties", "description":"Get Site properties related to specific customer.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/listSiteProperties_response" }, "examples":{ "application/json":{ "totalResults":1, "endingIndex":250, "offset":0, "totalResultsParam":true, "count":1, "limit":250, "links":[ { "rel":"self", "href":"http://agent.example.com:9080/ccagentui/v1/profiles/se-570031/siteProperties?siteProperties=%5Bobject%20Object%5D" } ], "sort":null, "items":[ { "site":{ "id":"SiteA" }, "properties":{ "GDPRProfileP13nConsentDate":"2018-03-21T13:10:08.463Z", "GDPRProfileP13nConsentGranted":true, "receiveEmail":"yes", "receiveEmailDate":"2018-03-21T13:10:08.463Z" } } ], "listingRequest":{ "endingIndex":250, "correctedView":null, "queryOptions":{ "precachedPropertyNames":null, "doNotCacheQuery":false, "sortDirectives":null, "endingIndex":250, "ignoreDuplicates":false, "nthIndex":1, "uncachedItems":false, "uncachedItemsSet":false, "startingIndex":0 }, "rqlString":null, "QErrorCodeMap":null, "QPropertyAliasMap":null, "sort":null, "startingIndex":0, "QIgnoreCase":true, "QString":null, "filterProperties":[ "displayName", "id" ], "includeRqlInQueryGeneration":true, "rqlStatement":null, "expanded":false, "scimParser":null, "useSCIMForQ":true, "limit":250, "siteId":null, "after":null, "calculateTotalAvailable":true }, "startingIndex":0, "totalNumberOfItems":1 } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|22030|User is not logged in|\n|22031|Internal error during get profile|\n|22032|Error occurred due to invalid data|\n" } }, "parameters":[ { "in":"path", "name":"id", "description":"The customer profile id.", "type":"string", "required":true } ], "tags":[ "Agent/Customers" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-profiles-{id}-siteProperties-get", "x-filename-id":"ccagent-v1-profiles-id-siteproperties-get" }, "put":{ "summary":"updateSiteProperties", "produces":[ "application/json" ], "operationId":"updateSiteProperties", "description":"Update site properties for specific customer. Example: Update receive email property with yes or no for specic site", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/updateSiteProperties_response" }, "examples":{ "application/json":{ "totalResults":1, "endingIndex":250, "offset":0, "totalResultsParam":true, "count":1, "limit":250, "links":[ { "rel":"self", "href":"http://localhost:9080/ccagentui/v1/profiles/se-570031/siteProperties" } ], "sort":null, "items":[ { "site":{ "id":"SiteA" }, "properties":{ "GDPRProfileP13nConsentDate":"2018-03-21T13:10:08.463Z", "GDPRProfileP13nConsentGranted":true, "receiveEmail":"yes", "receiveEmailDate":"2018-03-21T13:10:08.463Z" } } ], "listingRequest":{ "endingIndex":250, "correctedView":null, "queryOptions":{ "precachedPropertyNames":null, "doNotCacheQuery":false, "sortDirectives":null, "endingIndex":250, "ignoreDuplicates":false, "nthIndex":1, "uncachedItems":false, "uncachedItemsSet":false, "startingIndex":0 }, "rqlString":null, "QErrorCodeMap":null, "QPropertyAliasMap":null, "sort":null, "startingIndex":0, "QIgnoreCase":true, "QString":null, "filterProperties":[ "displayName", "id" ], "includeRqlInQueryGeneration":true, "rqlStatement":null, "expanded":false, "scimParser":null, "useSCIMForQ":true, "limit":250, "siteId":null, "after":null, "calculateTotalAvailable":true }, "startingIndex":0, "totalNumberOfItems":1 } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|200012|please provide valid input|\n|23010|City not specified in shipping address|\n|23011|Address line 1 not specified in shipping address|\n|22000|The profile id passes is null or empty.|\n|23012|No last name specified in shipping address|\n|22001|Internal error while getting the profile.|\n|23013|No first name specified in shipping address|\n|22002|No profile found with the given id.|\n|23015|Phone number not specified in shipping address|\n|23005|Invalid phone number in shipping address|\n|23007|No country specified in shipping address|\n|23008|Postal code not specified in shipping address|\n|22024|{0}({1}) must be a String|\n" } }, "parameters":[ { "in":"path", "name":"id", "description":"The customer profile id.", "type":"string", "required":true }, { "schema":{ "$ref":"#/definitions/updateSiteProperties_request" }, "in":"body", "name":"updateSiteProperties_request" } ], "tags":[ "Agent/Customers" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-profiles-{id}-siteProperties-put", "x-filename-id":"ccagent-v1-profiles-id-siteproperties-put" } }, "/ccagent/v1/merchant/orderCancelReasons":{ "get":{ "summary":"listCancelReasons", "produces":[ "application/json" ], "operationId":"listCancelReasons", "description":"List Cancel Reasons. Lists the Cancel Reasons for cancelling an order", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/listCancelReasons_response" }, "examples":{ "application/json":[ { "displayValue":"Bad product review", "key":"badProductReview" }, { "displayValue":"Better competitor price", "key":"betterCompetitorPrice" }, { "displayValue":"Change of mind", "key":"changeOfMind" }, { "displayValue":"Item available at discount currently", "key":"itemAvailableAtDiscountCurrently" }, { "displayValue":"No longer needed", "key":"noLongerNeeded" }, { "displayValue":"No update on shipment status", "key":"noUpdateOnShipmentStatus" } ] }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response" } }, "tags":[ "Agent/Merchant Settings" ], "x-internal-id":"ccagent-v1-merchant-orderCancelReasons-get", "x-filename-id":"ccagent-v1-merchant-ordercancelreasons-get" } }, "/ccagent/v1/saml/slo":{ "post":{ "summary":"single log out", "produces":[ "application/json" ], "operationId":"singleLogout", "description":"Single Log Out", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/singleLogout_response" }, "examples":{ "application/json":{ "result":true, "saml_slo_response":"Base64 encoded Single Logout Response", "saml_slo_response_dst":"https://localhost/fed/v1/idp/slo" } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|51301|Internal Error.|\n" } }, "parameters":[ { "schema":{ "$ref":"#/definitions/singleLogout_request" }, "in":"body", "name":"singleLogout_request" } ], "tags":[ "Agent/Agent Single Log out" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-saml-slo-post", "x-filename-id":"ccagent-v1-saml-slo-post" } }, "/ccagent/v1/merchant/configurationSettings":{ "get":{ "summary":"getConfigurationSettings", "produces":[ "application/json" ], "operationId":"getConfigurationSettings", "description":"Get Configuration Settings. To get the configuration details of a given configuration type ", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getConfigurationSettings_response" }, "examples":{ "application/json":{ "data":{ "cpqConfigSettings":{ "CPQReConfigurationURL":"http://slc10gpm.us.oracle.com", "CPQIFrameURL":"http://slc10gpm.us.oracle.com" } }, "links":[ { "rel":"self", "href":"http://localhost:9080/ccagentui/v1/merchant/configurationSettings?type=CPQConfigurationSettings" } ], "config":{ "displayName":"CPQ Configuration", "description":"CPQ Configuration Settings", "id":"CPQConfigurationSettings", "enabled":true } } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response" } }, "parameters":[ { "in":"header", "name":"x-ccsite", "description":"the site id corresponding to which site specific properties should be get", "type":"string", "required":true }, { "in":"query", "name":"type", "description":"setting type", "type":"string", "required":true } ], "tags":[ "Agent/Merchant Settings" ], "x-internal-id":"ccagent-v1-merchant-configurationSettings-get", "x-filename-id":"ccagent-v1-merchant-configurationsettings-get" } }, "/ccagent/v1/orders/getUpsellMessages":{ "get":{ "summary":"getUpsellMessages", "produces":[ "application/json" ], "operationId":"getUpsellMessages", "description":"Returns a list of unqualified promotion uspell messages.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getUpsellMessages_response" }, "examples":{ "application/json":{ "promotionUpsellMessages":[ { "text":"Spend $100 get free shipping!", "tags":[ "CART_UPSELL" ] }, { "text":"Spend $50 on Sports equipment get a free Sports DVD!", "tags":[ "BANNER_UPSELL", "CART_UPSELL" ] } ] } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response" } }, "tags":[ "Agent/Orders" ], "x-internal-id":"ccagent-v1-orders-getUpsellMessages-get", "x-filename-id":"ccagent-v1-orders-getupsellmessages-get" } }, "/ccagent/v1/orderTypes":{ "get":{ "summary":"listOrderTypes", "produces":[ "application/json" ], "operationId":"listOrderTypes", "description":"List Order Types. Lists all the order types.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/listOrderTypes_response" }, "examples":{ "application/json":{ "order":{ "displayName":"Order" } } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response" } }, "parameters":[ { "in":"query", "name":"orderTypeIds", "description":"An optional, comma separated list of specific order type ID's to retrieve.", "type":"string", "required":false }, { "in":"query", "name":"name", "description":"An optional partial displayName of a order type to use for search.", "type":"string", "required":false } ], "tags":[ "Agent/Order Types" ], "x-internal-id":"ccagent-v1-orderTypes-get", "x-filename-id":"ccagent-v1-ordertypes-get" } }, "/ccagent/v1/personalDataReports/requests/{id}":{ "get":{ "summary":"getClickstreamRequest", "produces":[ "application/json" ], "operationId":"getClickstreamRequest", "description":"Retreive status and information about a clickstream history report", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/clickstreamReportRecord" }, "description":"Status and information about requested clickstream report" }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"Error response" } }, "parameters":[ { "in":"path", "name":"id", "description":"Report ID", "type":"string", "required":true } ], "tags":[ "Agent/Privacy" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-personalDataReports-requests-{id}-get", "x-filename-id":"ccagent-v1-personaldatareports-requests-id-get" } }, "/ccagent/v1/shopperTypes":{ "get":{ "summary":"listShopperTypes", "produces":[ "application/json" ], "operationId":"listShopperTypes", "description":"List Shopper Types. Lists all the shopper types. Optionally takes the x-ccasset-language header to get translated content in another language.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/listShopperTypes_response" }, "examples":{ "application/json":{ "user":{ "displayName":"User" } } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response" } }, "parameters":[ { "in":"query", "name":"shopperTypeIds", "description":"An optional, comma separated list of specific shopper type ID's to retrieve.", "type":"string", "required":false }, { "in":"query", "name":"name", "description":"An optional partial displayName of a shopper type to use for search.", "type":"string", "required":false }, { "in":"header", "name":"X-CCAsset-Language", "description":"The asset language of the request", "type":"string", "required":false } ], "tags":[ "Agent/Shopper Types" ], "x-internal-id":"ccagent-v1-shopperTypes-get", "x-filename-id":"ccagent-v1-shoppertypes-get" } }, "/ccagent/v1/purchaseLists/{id}":{ "get":{ "summary":"getPurchaseList", "produces":[ "application/json" ], "operationId":"getPurchaseList", "description":"Get Purchase List. This operation is used to get the Purchase list information of a from Oracle Commerce Cloud.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getPurchaseList_response" }, "examples":{ "application/json":{ "owner":{ "lastName":"Anderson", "firstName":"Kim", "repositoryId":"se-570031", "id":"se-570031" }, "dynamicProperty":"dynamicProperty value", "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/ccagentui/v1/purchaseLists/gl30074" } ], "id":"gl30074", "creationDate":"2017-09-27T09:48:22.000Z", "items":[ { "dynamicProperty":"dynamicProperty value", "productId":"Product_5Cx", "quantityDesired":30, "repositoryId":"gi10001", "id":"gi10001", "catRefId":"Sku_5Cxy" } ] } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|64102|Error while fetching the purchase list|\n|64100|Invalid profile id|\n" } }, "parameters":[ { "in":"path", "name":"id", "description":"The ID of the requested Purchase list.", "type":"string", "required":true } ], "tags":[ "Agent/PurchaseLists" ], "x-internal-id":"ccagent-v1-purchaseLists-{id}-get", "x-filename-id":"ccagent-v1-purchaselists-id-get" }, "delete":{ "summary":"deletePurchaseList", "produces":[ "application/json" ], "operationId":"deletePurchaseList", "description":"Delete Purchase List. This operation is used to delete the Purchase list information from Oracle Commerce Cloud.", "responses":{ "200":{ "description":"The 200 ok response is returned on successfull delete." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|64105|Error while deleting the purchase list|\n|64100|Invalid profile id|\n" } }, "parameters":[ { "in":"path", "name":"id", "description":"The ID of the Purchase list.", "type":"string", "required":true } ], "tags":[ "Agent/PurchaseLists" ], "x-internal-id":"ccagent-v1-purchaseLists-{id}-delete", "x-filename-id":"ccagent-v1-purchaselists-id-delete" }, "put":{ "summary":"updatePurchaseList", "produces":[ "application/json" ], "operationId":"updatePurchaseList", "description":"Update Purchase List. This operation is used to update properties of a purchase list.\nDynamic 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.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/updatePurchaseList_response" }, "examples":{ "application/json":{ "owner":{ "lastName":"Anderson", "firstName":"Kim", "repositoryId":"se-570031", "id":"se-570031" }, "dynamicProperty":"dynamicProperty value", "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/ccagentui/v1/purchaseLists/gl30074" } ], "id":"gl30074", "creationDate":"2017-09-27T09:48:22.000Z", "items":[ { "dynamicProperty":"dynamicProperty value", "productId":"Product_5Cx", "quantityDesired":30, "repositoryId":"gi10001", "id":"gi10001", "catRefId":"Sku_5Cxy" } ] } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|64104|Error while updating the purchase list.|\n|64100|Invlaid profile id|\n" } }, "parameters":[ { "in":"path", "name":"id", "description":"The ID of the Purchase List to be updated.", "type":"string", "required":true }, { "schema":{ "$ref":"#/definitions/updatePurchaseList_request" }, "in":"body", "name":"updatePurchaseList_request" } ], "tags":[ "Agent/PurchaseLists" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-purchaseLists-{id}-put", "x-filename-id":"ccagent-v1-purchaselists-id-put" } }, "/ccagent/v1/returnRequests":{ "post":{ "summary":"initiateReturn", "produces":[ "application/json" ], "operationId":"initiateReturn", "description":"Initiate Return. It creates the return request based on the operation value. Operation value can be any of initiateReturn/calculateRefundAmounts/createReturnRequest. Gets list of items from an order for which return request can be created with operation set as 'initiateReturn'.Additonally takes x-ccsite header. If the site information is not provided by default it takes the order site. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/initiateReturn_response" }, "examples":{ "application/json":{ "returnLabel":"return label 1", "returnItems":[ { "quantityReturned":0, "unitPrice":9.99, "shippingGroup":{ "firstName":null, "lastName":null, "emailAddress":null, "phoneNumber":null, "locationId":"testLoc2", "shippingMethod":{ "shippingMethod":"inStorePickupShippingGroup", "shippingMethodDescription":"inStorePickupShippingGroup" }, "shippingGroupId":"sg40412", "middleName":null, "store":{ "country":"USA", "hours":"Mon - Sat 10AM - 7PM Sun 11AM - 6 PM", "address3":null, "address2":"15th Floor", "city":"San Francisco", "address1":"475 Sansome Street", "postalCode":"94111", "county":null, "stateAddress":"CA", "phoneNumber":"(617) 386-1200", "locationId":"testLoc2", "name":"Cloud Store - SanFrancisco", "faxNumber":"(617) 386-1200", "email":"store113@example.com" }, "type":"inStorePickupShippingGroup" }, "comments":null, "productId":"prod10035", "displayName":"Fifa 2010", "dynamicProperties":[ { "id":"ReferralCode", "label":"ReferralCode", "value":null }, { "id":"OfferEndsDate", "label":"OfferEndsDate", "value":"2020-07-02T03:42:42.962Z" }, { "id":"Discount", "label":"Discount", "value":10 }, { "id":"GiftWrapping", "label":"Gift Wrapping", "value":false }, { "id":"name", "label":"Name on product(Mug)", "value":"My name" } ], "shippingGroupId":"sg80417", "externalData":[ ], "childItems":[ { "serviceAccountId":"serviceAcc-123", "deactivationDate":"2018-06-27T12:59:59Z", "quantity":2, "productId":"prod10040", "displayName":"Super Smash Brothers Brawl", "externalData":[ ], "parentAssetKey":"12345", "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "childItems":[ { "serviceAccountId":"serviceAcc-123", "deactivationDate":"2018-06-27T12:59:59Z", "quantity":1, "productId":"prod10039", "displayName":"Wii Music I ", "externalData":[ ], "parentAssetKey":"23456", "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "rootAssetKey":"12345", "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"sku10049", "assetKey":"93659", "route":"product/prod10039", "customerAccountId":"customerAcc-123", "selectedOptions":[ ], "actionCode":"Add", "activationDate":"2017-06-27T15:30:00Z", "serviceId":"service-123", "asset":false } ], "rootAssetKey":"12345", "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"sku10041", "assetKey":"23456", "route":"product/prod10040", "customerAccountId":"customerAcc-123", "selectedOptions":[ ], "actionCode":"Add", "activationDate":"2017-06-27T15:30:00Z", "serviceId":"service-123", "asset":false }, { "serviceAccountId":"serviceAcc-123", "deactivationDate":"2018-06-27T12:59:59Z", "quantity":1, "productId":"prod10038", "displayName":"Wii Music", "externalData":[ ], "parentAssetKey":"12345", "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "rootAssetKey":"12345", "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"sku10042", "assetKey":"64634", "route":"product/prod10038", "customerAccountId":"customerAcc-123", "selectedOptions":[ ], "actionCode":"Add", "activationDate":"2017-06-27T15:30:00Z", "serviceId":"service-123", "asset":false } ], "catRefId":"sku10037", "configuratorId":"12345677", "skuOptionInfo":[ ], "quantityAvailableForReturn":3, "commerceItemId":"ci9000467", "skuProperties":[ { "propertyType":"sku-base", "name":"Name", "id":"displayName", "value":null }, { "propertyType":"sku-base", "name":"Id", "id":"id", "value":"camerasku_1_1" }, { "propertyType":"sku-custom", "name":"dynamicskuprop1", "id":"dynamicskuprop1", "value":"dynamicskuprop1" } ], "quantityShipped":3, "price":29.97, "actionCode":"Add", "additionalProperties":{ "description":"Additional properties of the return item", "type":"object", "properties":{ "property2":{ "description":"Additional Property 2", "type":"string" }, "property1":{ "description":"Additional Property 1", "type":"string" } } } } ], "profileInfo":{ "lastName":"Anderson", "firstName":"Kim", "organization":{ "name":"Oracle India Pvt Ltd", "id":"oracle" }, "middleName":null, "email":"kim@example.com" }, "orderInfo":{ "originOfOrder":"contactCenter", "priceInfo":{ "total":58.4, "amount":29.97, "shipping":25, "isTaxIncluded":false, "tax":3.43, "subTotal":29.97, "orderDiscountAmount":0, "currencyCode":"USD", "totalWithoutTax":127.97 }, "recurringChargePriceInfo":{ "amount":20, "total":20, "shipping":0, "subTotalByFrequency":[ { "amount":20, "frequency":"Monthly" } ], "taxByFrequency":[ { "amount":0, "frequency":"Monthly" } ], "tax":0, "subTotal":20, "currencyCode":"USD", "totalWithoutTax":20 }, "orderId":"o10400", "priceListGroup":{ "deleted":false, "displayName":"UsDollar", "repositoryId":"UsDollar", "listPriceList":{ "repositoryId":"listPrices" }, "active":true, "salePriceList":{ "repositoryId":"salePrices" }, "currency":{ "symbol":"$", "displayName":"US Dollar", "repositoryId":"hi_US", "fractionalDigits":2, "currencyCode":"USD", "numericCode":"356" }, "id":"UsDollar", "locale":"hi_US", "shippingSurchargePriceList":{ "repositoryId":"shippingSurchargePrices" } }, "siteId":"siteUS", "creationDate":"2014-05-20 16:06:44.0", "submittedDate":"2014-05-20 16:07:44.0" }, "links":[ { "rel":"self", "href":"http://localhost:9080/ccagentui/v1/returnRequests" } ], "additionalProperties":{ "property2":"tag", "property":"display" }, "quoteInfo":{ "providerNote":null, "notes":[ { "providerDate":"2016-11-25T13:33:48.000Z", "providerNote":"The quote is approved as per the request", "profileType":null, "profileId":"se-570031" }, { "profileType":null, "profileId":"se-570031", "requestDate":"2016-10-25T13:33:48.000Z", "requesterNote":"provide 10 percent off on the total quantity" } ], "rejectionDate":null, "requestDate":"2016-10-25T13:33:48.000Z", "errorInfo":null, "externalID":null, "rejectionNote":null, "quoteDate":"2016-10-25T13:35:32.000Z", "expirationDate":"2026-04-28T18:53:48.000Z" }, "trackingNumber":[ "http://localhost:9080/trackingNumber", "http://localhost:9080/trackingNumber2" ] } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|100094|Organization passed in the header is currently inactive|\n|100095|The order or return request does not belong to the current organization of the shopper profile|\n|100096|The organization associated to the order or return request was deleted / does not exist|\n|100097|The organization associated to the order or return request is currently inactive|\n|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|\n|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|\n|200114|Order is not allowed for return.|\n|30015|SiteId passed in x-ccsite header is currently inactive|\n|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|\n|30020|The Site to which the order belongs was deleted|\n|30021|The Site to which the order belongs is currently inactive|\n|100101|The shopper profile does not belong to organization passed in the header|\n|30019|SiteId passed in x-ccsite header is not related to the order being worked upon|\n|210105|Specified order does not exist.|\n|200196|Item {0} is a part of configuration and therefore cannot be returned separately. Please return the whole configuration package.|\n" } }, "parameters":[ { "in":"header", "name":"x-ccsite", "description":"the site id on which the orders is laced", "type":"string", "required":false }, { "in":"header", "name":"X-CCOrganization", "description":"The organization Id to which the order belongs", "type":"string", "required":false }, { "schema":{ "$ref":"#/definitions/initiateReturn_request" }, "in":"body", "name":"initiateReturn_request" } ], "tags":[ "Agent/Return Order" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-returnRequests-post", "x-filename-id":"ccagent-v1-returnrequests-post" }, "get":{ "summary":"searchReturns", "produces":[ "application/json" ], "operationId":"searchReturns", "description":"Search Returns. Gets a list of return requests from the repository based on given search criteria. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/searchReturns_response" }, "examples":{ "application/json":{ "links":[ { "rel":"self", "href":"http://localhost:9080/ccagentui/v1/returnRequests?q=%7B%22returnRequestId%22%3A%22300001%22%2C%22authorizationNumber%22%3A%22300002%22%2C%22orderId%22%3A%22%22%2C%22email%22%3A%22%22%2C%22startDateFromTimeSpan%22%3A%22%22%2C%22limit%22%3A20%2C%22pageNumber%22%3A0%7D" } ], "totalRequests":1, "searchResults":[ { "returnRequestId":"100003", "lastName":"Anderson", "isExchangeRequest":false, "orderId":"o10401", "totalRefund":36.46, "priceListGroup":{ "deleted":false, "displayName":"UsDollar", "repositoryId":"UsDollar", "listPriceList":{ "repositoryId":"listPrices" }, "active":true, "salePriceList":{ "repositoryId":"salePrices" }, "currency":{ "symbol":"$", "displayName":"US Dollar", "repositoryId":"en_US", "fractionalDigits":2, "currencyCode":"USD", "numericCode":"840" }, "id":"UsDollar", "locale":"en_US", "shippingSurchargePriceList":{ "repositoryId":"shippingSurchargePrices" } }, "firstName":"Kim", "authorizationNumber":"100001", "createdDate":"2015-05-12T11:04:09.000Z", "siteId":"siteUS", "state":"Approved", "totalReturnQuantity":1, "operation":"process" } ] } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|200020|Search Criteria passed is null or empty|\n|100094|Organization passed in the header is currently inactive|\n|100095|The order or return request does not belong to the current organization of the shopper profile|\n|100096|The organization associated to the order or return request was deleted / does not exist|\n|100097|The organization associated to the order or return request is currently inactive|\n|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|\n|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|\n|100101|The shopper profile does not belong to organization passed in the header|\n|200127|Internal error occurred.|\n|200137|Invalid limit|\n|200136|Invalid offset or limit|\n" } }, "parameters":[ { "in":"query", "name":"q", "description":"Search criteria to filter the search results based on various fields like email etc. Following are the fields supported by this param: \n\n|Field|Type|Description|\n|------------------|------------------|------------------|\n|returnRequestId|string|The Return Request ID.|\n|authorizationNumber|string|RMA is the merchant authorization number required for validation.|\n|pageNumber|integer|The page number for pagination.|\n|orderId|string|Order id|\n|limit|integer|The batch size of the return requests to be fetched together.|\n|siteId|string|site id of the return request|\n|state|string|state of the return request eg. PENDING_REFUND|\n|startDateFromTimeSpan|string|Date to start searching from like \"yyyy-mm-ddThh:mm:ss.sssz\" |\n|email|string|Email id of the customer profile|\n|account|string|Account id of the return requests to be fetched|\n", "type":"string", "required":true }, { "in":"header", "name":"X-CCOrganization", "description":"The organization Id to which the order belongs", "type":"string", "required":false } ], "tags":[ "Agent/Return Order" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-returnRequests-get", "x-filename-id":"ccagent-v1-returnrequests-get" } }, "/ccagent/v1/sites/{id}/cartSharingSites":{ "get":{ "summary":"getCartSharingSites", "produces":[ "application/json" ], "operationId":"getCartSharingSites", "description":" Get all sites that belong to the same site group as the input site ID.\n There are couple of query parameters - includeGivenSite and includeInactiveSites to control\n whether the input site should be returned in the response and\n whether the inactive sites should be returned in the response.\n By default includeGiveSite is false while includeInactiveSites is true.\n Optionally takes the x-ccasset-language header to get translated content in another language.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getSharingSite_response" }, "examples":{ "application/json":{ "items":[ { "productionURL":"localhost:8080", "name":"Site Agent", "id":"SiteA", "enabled":true }, { "productionURL":"localhostSiteUS:8080", "name":"Commerce Cloud Site", "id":"siteUS", "enabled":true } ], "startingIndex":0, "totalNumberOfItems":2 } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response" } }, "parameters":[ { "in":"path", "name":"id", "description":"The ID of the site for which sharing sites should be retrieved.", "type":"string", "required":true }, { "in":"query", "name":"showTranslations", "description":"Boolean indicating if the translations property should be returned for each item in the response. The default value is false.", "type":"boolean", "required":false }, { "in":"query", "name":"includeGivenSite", "description":"Boolean indicating if the given site should be included in the response. The default value is false.", "type":"boolean", "required":false }, { "in":"query", "name":"includeInactiveSites", "description":"Boolean indicating if Inactive sites should be included in the response. The default value is true.", "type":"boolean", "required":false } ], "tags":[ "Agent/Sites" ], "x-internal-id":"ccagent-v1-sites-{id}-cartSharingSites-get", "x-filename-id":"ccagent-v1-sites-id-cartsharingsites-get" } }, "/ccagent/v1/merchant/returnStates":{ "get":{ "summary":"getReturnStates", "produces":[ "application/json" ], "operationId":"getReturnStates", "description":"Get Return States. Lists the Order States when Return action will be allowed against orders", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getReturnStates_response" }, "examples":{ "application/json":[ { "displayKey":"PENDING_CUSTOMER_ACTION", "displayName":"Approved" }, { "displayKey":"COMPLETE", "displayName":"Complete" }, { "displayKey":"FULL_RETURN", "displayName":"Full return" }, { "displayKey":"PARTIAL_RETURN", "displayName":"Partial return" }, { "displayKey":"PENDING_REFUND", "displayName":"Pending Refund" } ] }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response" } }, "tags":[ "Agent/Merchant Settings" ], "x-internal-id":"ccagent-v1-merchant-returnStates-get", "x-filename-id":"ccagent-v1-merchant-returnstates-get" } }, "/ccagent/v1/organizationMembers/{id}":{ "get":{ "summary":"getMember", "produces":[ "application/json" ], "operationId":"getMember", "description":"Get Member. This operation is used to get the profile information of a customer that is associated to an account from Oracle Commerce Cloud. Takes X-CCAgentContext header which is a JSON object with 'shopperProfileId' as a property. If 'shopperProfileId' is not provided, it is considered as an anonymous profile. Optionally takes the x-ccasset-language header to get translated content in another language. Also it takes X-CCOrganization header which is a JSON field with organization ID as value. If this header is not provided, then the endPoint will consider first active organization as the current organization. This endpoint is different from getProfile endpoint. Certain additional details like hasIncompleteOrder property, etc which are necessary for creating or editing orders are returned by getProfile endpoint, whereas only profile and account specific details are returned by getMember endpoint.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getMember_response" }, "examples":{ "application/json":{ "lastName":"Blooming", "GDPRProfileP13nConsentDate":"2018-03-23T09:02:31.955Z", "GDPRProfileP13nConsentGranted":true, "customerContactId":"CRMID_1", "dynamicProperties":[ { "uiEditorType":"shortText", "default":"Field1", "length":null, "id":"field1", "label":"Nickname", "type":"string", "value":"Field1", "required":false } ], "roles":[ { "associations":[ { "relatedItemId":"or-100001", "type":"organization" } ], "function":"admin", "relativeTo":{ "id":"or-100001" }, "repositoryId":"100001", "name":"Admin", "id":"100001", "type":"organizationalRole" }, { "associations":[ { "relatedItemId":"or-100001", "type":"organization" } ], "function":"buyer", "relativeTo":{ "id":"or-100001" }, "repositoryId":"100002", "name":"Buyer", "id":"100002", "type":"organizationalRole" }, { "associations":[ { "relatedItemId":"or-100001", "type":"organization" } ], "function":"buyer", "relativeTo":{ "id":"or-100002" }, "repositoryId":"100004", "name":"Buyer", "id":"100004", "type":"organizationalRole" } ], "receiveEmail":"yes", "active":true, "locale":"en", "parentOrganization":{ "approvalRequired":true, "repositoryId":"or-100001", "punchoutUserId":"100012", "name":"National Discount Auto Parts", "active":true, "description":null, "shippingAddress":{ "repositoryId":"ci-110024" }, "secondaryAddresses":{ "Address2":{ "repositoryId":"ci-110024" }, "Address1":{ "repositoryId":"ci-110023" } }, "billingAddress":{ "repositoryId":"ci-110024" }, "id":"or-100001", "externalOrganizationId":"EXT_ORG_1", "orderPriceLimit":50 }, "receiveEmailDate":"2018-03-23T09:02:31.955Z", "orderPriceLimit":50, "firstName":"Ron", "profileType":"b2b_user", "repositoryId":"bb-110023", "links":[ { "rel":"self", "href":"ccagent/v1/organizationMembers/bb-110023" } ], "id":"bb-110023", "secondaryOrganizations":[ { "approvalRequired":false, "repositoryId":"or-100002", "name":"US Motor Works, Inc.", "active":true, "description":"US Motor Works, Inc.", "shippingAddress":{ "repositoryId":"ci-110029" }, "secondaryAddresses":{ "Address1":{ "repositoryId":"ci-110029" } }, "billingAddress":{ "repositoryId":"ci-110029" }, "id":"or-100002", "externalOrganizationId":"EXT_ORG_1", "orderPriceLimit":null } ], "email":"ron@example.com" } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|22010|If the profile id passed is not associated to the account of the profileId passed in the AgentContext header.|\n|22000|If the profile id passed is null or empty|\n|22001|If there was any internal error while getting the profile|\n|22002|If there was no profile found with the given id|\n|82005000|If there is an error while processing the AgentContext header. Possible reasons include invalid profileId, incorrect JSON format or other errors|\n|89103|If no shopperProfileId is passed in the AgentContext header|\n|89102|If the shopperProfile passed in the AgentContext header or the associated account is inactive|\n|89101|If the shopperProfile passed in the AgentContext header is not an administrator for the account|\n|22007|If the profile id passed is not associated to the account of the profileId passed in the AgentContext header.|\n" } }, "parameters":[ { "in":"query", "name":"includedRoles", "description":"This field determines if only organizational roles or all roles are to be returned for the member. Default value is 'organizationalRolesForCurrentOrganization'. Possible values are 'organizationalRolesForCurrentOrganization', 'allRolesForCurrentOrganization'.", "type":"string", "required":false }, { "in":"header", "name":"X-CCAsset-Language", "description":"The asset language of the request. E.g., en,de,fr_CA.", "type":"string", "required":false }, { "in":"header", "name":"X-CCOrganization", "description":"The organization Id associated with the shopper profile", "type":"string", "required":false }, { "in":"header", "name":"X-CCSite", "description":"The site Id to retrieve the site specific shopper profile properties", "type":"string", "required":false }, { "in":"header", "name":"X-CCAgentContext", "description":"The Agent Context is a JSON object with shopperProfileId as a property.", "type":"string", "required":true }, { "in":"path", "name":"id", "description":"The ID of the requested shopper profile.", "type":"string", "required":true } ], "tags":[ "Agent/Organization Members" ], "x-internal-id":"ccagent-v1-organizationMembers-{id}-get", "x-filename-id":"ccagent-v1-organizationmembers-id-get" }, "put":{ "summary":"updateMember", "produces":[ "application/json" ], "operationId":"updateMember", "description":"Update Member. This operation is used to update customer name, email, role, status and dynamic properties of a customer profile. Takes X-CCAgentContext header which is a JSON object with 'shopperProfileId' as a property. If 'shopperProfileId' is not provided, it is considered as an anonymous profile. Also it takes X-CCOrganization header which is a JSON field with organization ID as value.If this header is not provided, then the endPoint will consider first active organization as the current organization.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/updateMember_response" }, "examples":{ "application/json":{ "lastName":"Dilliard", "GDPRProfileP13nConsentDate":"2018-03-23T09:02:31.000Z", "GDPRProfileP13nConsentGranted":true, "customerContactId":"CRMID_1", "dynamicProperties":[ { "uiEditorType":"shortText", "default":"Field1", "length":null, "id":"dynamicProperty1", "label":"Nickname", "type":"string", "value":"dynamicPropertyValue", "required":false } ], "roles":[ { "function":"admin", "relativeTo":"or-100001", "repositoryId":"100001" }, { "function":"buyer", "relativeTo":"or-100001", "repositoryId":"100002" } ], "receiveEmail":"yes", "active":true, "locale":"en", "parentOrganization":{ "active":true, "description":null, "secondaryAddresses":{ "Address2":{ "repositoryId":"ci-110024" }, "Address1":{ "repositoryId":"ci-110023" } }, "externalOrganizationId":"EXT_ORG_1", "orderPriceLimit":50, "approvalRequired":true, "repositoryId":"or-100001", "punchoutUserId":"100012", "name":"National Discount Auto Parts", "shippingAddress":{ "repositoryId":"ci-110024" }, "billingAddress":{ "repositoryId":"ci-110024" }, "id":"or-100001", "useExternalApprovalWebhook":false }, "receiveEmailDate":"2018-03-23T09:02:22.000Z", "orderPriceLimit":50, "firstName":"Leota", "profileType":"b2b_user", "repositoryId":"bb-110006", "links":[ { "rel":"self", "href":"http://localhost:9080/ccagentui/v1/organizationMembers/bb-110006" } ], "id":"bb-110006", "secondaryOrganizations":[ ], "email":"leota@example.com" } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|22000|If the profile id passed is null or empty|\n|23012|If no last name is specified|\n|22001|If there was any internal error while getting the profile|\n|23013|If no first name is specified|\n|22002|If there was no profile found with the given id|\n|82005000|If there is an error while processing the AgentContext header. Possible reasons include invalid profileId, incorrect JSON format or other errors|\n|200019|If an account already exists for the given email address|\n|23006|If invalid email address is specified|\n|22007|If the profile id passed is not associated to the account of the profile id passed in the AgentContext header|\n|22010|If the profile id passed is not associated to the account of the profileId passed in the AgentContext header.|\n|89103|If no shopperProfileId is passed in the AgentContext header|\n|89102|If the shopperProfile passed in the AgentContext header or the associated account is inactive|\n|89101|If the shopperProfile passed in the AgentContext header is not an administrator for the account|\n|13036|One of the dynamic properties is not writable by the Agent user|\n" } }, "parameters":[ { "in":"header", "name":"X-CCAsset-Language", "description":"The asset language of the request", "type":"string", "required":false }, { "in":"header", "name":"X-CCOrganization", "description":"The organization Id associated with the shopper profile", "type":"string", "required":false }, { "in":"header", "name":"X-CCSite", "description":"The site Id to update the site specific shopper profile properties", "type":"string", "required":false }, { "in":"header", "name":"X-CCAgentContext", "description":"The Agent Context is a JSON object with shopperProfileId as a property.", "type":"string", "required":true }, { "in":"path", "name":"id", "description":"The ID of the shopper profile to be updated.", "type":"string", "required":true }, { "schema":{ "$ref":"#/definitions/updateMember_request" }, "in":"body", "name":"updateMember_request" } ], "tags":[ "Agent/Organization Members" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-organizationMembers-{id}-put", "x-filename-id":"ccagent-v1-organizationmembers-id-put" } }, "/ccagent/v1/purchaseLists/{id}/updateItems":{ "post":{ "summary":"updateItems", "produces":[ "application/json" ], "operationId":"updateItems", "description":"Update Purchase List Items. This operation is used to update the purchase list items. \nBasic operations include add, delete, update. add operation is considered as default if nothing is specified in the input payload.\nDynamic Properties of 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.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/updatePurchaseListItems_response" }, "examples":{ "application/json":{ "success":true, "messsage":"Purchase List Item(s) updated successfully." } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|64107|Error while adding an item to purchase list|\n|64100|Invalid profile or user logged out|\n|64106|Error while removing an item from purchase list|\n|64109|Error while updating an item of purchase list" } }, "parameters":[ { "schema":{ "$ref":"#/definitions/updatePurchaseListItems_request" }, "in":"body", "name":"updatePurchaseListItems_request" }, { "in":"path", "name":"id", "description":"The ID of the Purchase list.", "type":"string", "required":true } ], "tags":[ "Agent/PurchaseLists" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-purchaseLists-{id}-updateItems-post", "x-filename-id":"ccagent-v1-purchaselists-id-updateitems-post" } }, "/ccagent/v1/shippingMethods":{ "post":{ "summary":"listShippingMethods", "produces":[ "application/json" ], "operationId":"listShippingMethods", "description":"List Shipping Methods. Get a list of shipping methods that are valid for a given address.This Endpoint is clone of StoreFront endpoint and it can be used if application running on agent/admin server need access to shipping methods data configured for StoreFront.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/listShippingMethods_response" }, "examples":{ "application/json":[ { "items":[ { "shippingGroupId":"sg960413", "shippingAddress":{ "lastName":"sample", "country":"US", "city":"City01", "prefix":"", "postalCode":"94085", "jobTitle":"", "companyName":"", "county":"", "isDefaultAddress":true, "suffix":"", "selectedCountry":"US", "populateShippingMethods":false, "alias":"Address", "state":"CA", "selectedState":"CA", "email":"sample@example.com", "state_ISOCode":"US-CA", "address3":"", "address2":"Address2", "address1":"11 Address Line", "defaultCountryCode":null, "firstName":"sample", "phoneNumber":"5345345", "faxNumber":"", "middleName":"" }, "items":[ { "commerceItemId":"ci7000501", "quantity":2, "productId":"Product_15CD", "childItems":[ { "addOnItem":true, "quantity":1, "productId":"Product_18Cxi", "displayName":"Dr. Dolittle", "catRefId":"Sku_18Dxi" } ], "catRefId":"Sku_15DE" }, { "quantity":2, "productId":"Product_36Exy", "catRefId":"Sku_36Fxy" } ], "shippingMethods":[ { "shippingCalculator":"priceRange", "eligibleForProductWithSurcharges":null, "isExternallyPriced":false, "ranges":[ { "amount":25, "high":99.99, "low":0, "repositoryId":"standardRange_01" }, { "amount":35, "high":null, "low":100, "repositoryId":"standardRange_02" } ], "associatedPriceListGroups":[ ], "displayName":"Standard", "description":null, "allSites":true, "sites":[ ], "taxCode":null, "type":0, "shippingGroupType":"hardgoodShippingGroup", "enabled":true, "displaySequence":0, "repositoryId":"standardShippingMethod", "excludedCategoriesShippingCharge":[ ], "isFallback":false, "id":"standardShippingMethod", "shipToLocations":[ { "repositoryId":"100001" } ], "excludedCategories":[ ] }, { "shippingCalculator":"priceRange", "eligibleForProductWithSurcharges":null, "isExternallyPriced":false, "ranges":[ { "amount":25, "high":99.99, "low":0, "repositoryId":"priorityRange_01" }, { "amount":35, "high":null, "low":100, "repositoryId":"priorityRange_02" } ], "associatedPriceListGroups":[ ], "displayName":"Priority", "description":null, "allSites":true, "sites":[ ], "taxCode":null, "type":0, "shippingGroupType":"hardgoodShippingGroup", "enabled":true, "displaySequence":4, "repositoryId":"priorityShippingMethod", "excludedCategoriesShippingCharge":[ ], "isFallback":false, "id":"priorityShippingMethod", "shipToLocations":[ { "repositoryId":"100001" } ], "excludedCategories":[ ] }, { "shippingCalculator":"priceRange", "eligibleForProductWithSurcharges":null, "isExternallyPriced":false, "ranges":[ { "amount":0, "high":null, "low":0, "repositoryId":"freeRange_01" } ], "associatedPriceListGroups":[ ], "displayName":"Free Shipping", "description":null, "allSites":true, "sites":[ ], "taxCode":null, "type":0, "shippingGroupType":"hardgoodShippingGroup", "enabled":true, "displaySequence":5, "repositoryId":"freeShippingMethod", "excludedCategoriesShippingCharge":[ ], "isFallback":false, "id":"freeShippingMethod", "shipToLocations":[ { "repositoryId":"100001" } ], "excludedCategories":[ ] }, { "shippingCalculator":"priceRange", "eligibleForProductWithSurcharges":null, "isExternallyPriced":false, "ranges":[ { "amount":25, "high":99.99, "low":0, "repositoryId":"twoDayRange_01" }, { "amount":35, "high":null, "low":100, "repositoryId":"twoDayRange_02" } ], "associatedPriceListGroups":[ ], "displayName":"Two Day", "description":null, "allSites":true, "sites":[ ], "taxCode":null, "type":0, "shippingGroupType":"hardgoodShippingGroup", "enabled":true, "displaySequence":6, "repositoryId":"twoDayShippingMethod", "excludedCategoriesShippingCharge":[ ], "isFallback":false, "id":"twoDayShippingMethod", "shipToLocations":[ { "repositoryId":"100001" } ], "excludedCategories":[ ] }, { "shippingCalculator":"priceRange", "eligibleForProductWithSurcharges":null, "isExternallyPriced":false, "ranges":[ { "amount":4.5, "high":49.99, "low":0, "repositoryId":"groundRange_01" }, { "amount":8.5, "high":99.99, "low":50, "repositoryId":"groundRange_02" }, { "amount":11, "high":null, "low":100, "repositoryId":"groundRange_03" } ], "associatedPriceListGroups":[ ], "displayName":"Ground", "description":null, "allSites":true, "sites":[ ], "taxCode":null, "type":0, "shippingGroupType":"hardgoodShippingGroup", "enabled":true, "displaySequence":7, "repositoryId":"groundShippingMethod", "excludedCategoriesShippingCharge":[ ], "isFallback":false, "id":"groundShippingMethod", "shipToLocations":[ { "repositoryId":"100001" } ], "excludedCategories":[ ] }, { "shippingCalculator":"priceRange", "eligibleForProductWithSurcharges":null, "isExternallyPriced":false, "ranges":[ { "amount":35, "high":99.99, "low":0, "repositoryId":"overNightRange_01" }, { "amount":45, "high":null, "low":100, "repositoryId":"overNightRange_02" } ], "associatedPriceListGroups":[ ], "displayName":"Overnight", "description":null, "allSites":true, "sites":[ ], "taxCode":"FR020400", "type":0, "shippingGroupType":"hardgoodShippingGroup", "enabled":true, "displaySequence":9, "repositoryId":"overNightShippingMethod", "excludedCategoriesShippingCharge":[ ], "isFallback":false, "id":"overNightShippingMethod", "shipToLocations":[ { "repositoryId":"100001" } ], "excludedCategories":[ ] }, { "shippingCalculator":"external", "eligibleForProductWithSurcharges":true, "estimatedDeliveryDateGuaranteed":false, "isExternallyPriced":false, "internationalDutiesTaxesFees":0, "ranges":[ { "amount":14.95, "high":"179769313486231570000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "low":0 } ], "displayName":"canadapost-overnight", "taxCode":"GT987", "shippingGroupType":"hardgoodShippingGroup", "estimatedDeliveryDate":"2013-04-12 14:48:45 -0400", "enabled":true, "deliveryDays":2, "repositoryId":"canadapost-overnight", "isFallback":false, "carrierId":"ON" }, { "shippingCalculator":"external", "estimatedDeliveryDateGuaranteed":false, "isExternallyPriced":false, "internationalDutiesTaxesFees":0, "ranges":[ { "amount":33, "high":"179769313486231570000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "low":0 } ], "displayName":"fedex-2dayground", "taxCode":"TD543", "shippingGroupType":"hardgoodShippingGroup", "estimatedDeliveryDate":"2013-04-12 14:48:45 -0400", "enabled":true, "deliveryDays":2, "repositoryId":"fedex-2dayground", "isFallback":false, "carrierId":"1D" } ] }, { "shippingGroupId":"sg960414", "shippingAddress":{ "lastName":"sample", "country":"US", "city":"City2", "prefix":"", "postalCode":"03031", "jobTitle":"", "companyName":"", "county":"", "isDefaultAddress":false, "suffix":"", "selectedCountry":"US", "populateShippingMethods":false, "alias":"Address##3", "state":"NH", "selectedState":"NH", "email":"sample@example.com", "state_ISOCode":"US-NH", "address3":"", "address2":"Address2", "address1":"22 Address1", "defaultCountryCode":null, "firstName":"sample no tax", "phoneNumber":"675675675", "faxNumber":"", "middleName":"" }, "items":[ { "commerceItemId":"ci7000501", "quantity":2, "productId":"Product_15CD", "childItems":[ { "addOnItem":true, "quantity":1, "productId":"Product_18Cxi", "displayName":"Dr. Dolittle", "catRefId":"Sku_18Dxi" } ], "catRefId":"Sku_15DE" }, { "quantity":2, "productId":"Product_36Exy", "catRefId":"Sku_36Fxy" } ], "shippingMethods":[ { "shippingCalculator":"priceRange", "eligibleForProductWithSurcharges":null, "isExternallyPriced":false, "ranges":[ { "amount":25, "high":99.99, "low":0, "repositoryId":"standardRange_01" }, { "amount":35, "high":null, "low":100, "repositoryId":"standardRange_02" } ], "associatedPriceListGroups":[ ], "displayName":"Standard", "description":null, "allSites":true, "sites":[ ], "taxCode":null, "type":0, "shippingGroupType":"hardgoodShippingGroup", "enabled":true, "displaySequence":0, "repositoryId":"standardShippingMethod", "excludedCategoriesShippingCharge":[ ], "isFallback":false, "id":"standardShippingMethod", "shipToLocations":[ { "repositoryId":"100001" } ], "excludedCategories":[ ] }, { "shippingCalculator":"priceRange", "eligibleForProductWithSurcharges":null, "ranges":[ { "amount":25, "high":99.99, "low":0, "repositoryId":"priorityRange_01" }, { "amount":35, "high":null, "low":100, "repositoryId":"priorityRange_02" } ], "associatedPriceListGroups":[ ], "displayName":"Priority", "description":null, "allSites":true, "sites":[ ], "taxCode":null, "type":0, "shippingGroupType":"hardgoodShippingGroup", "enabled":true, "displaySequence":4, "repositoryId":"priorityShippingMethod", "excludedCategoriesShippingCharge":[ ], "isFallback":false, "id":"priorityShippingMethod", "shipToLocations":[ { "repositoryId":"100001" } ], "excludedCategories":[ ] }, { "shippingCalculator":"priceRange", "eligibleForProductWithSurcharges":null, "ranges":[ { "amount":0, "high":null, "low":0, "repositoryId":"freeRange_01" } ], "associatedPriceListGroups":[ ], "displayName":"Free Shipping", "description":null, "allSites":true, "sites":[ ], "taxCode":null, "type":0, "shippingGroupType":"hardgoodShippingGroup", "enabled":true, "displaySequence":5, "repositoryId":"freeShippingMethod", "excludedCategoriesShippingCharge":[ ], "isFallback":false, "id":"freeShippingMethod", "shipToLocations":[ { "repositoryId":"100001" } ], "excludedCategories":[ ] }, { "shippingCalculator":"priceRange", "eligibleForProductWithSurcharges":null, "ranges":[ { "amount":25, "high":99.99, "low":0, "repositoryId":"twoDayRange_01" }, { "amount":35, "high":null, "low":100, "repositoryId":"twoDayRange_02" } ], "associatedPriceListGroups":[ ], "displayName":"Two Day", "description":null, "allSites":true, "sites":[ ], "taxCode":null, "type":0, "shippingGroupType":"hardgoodShippingGroup", "enabled":true, "displaySequence":6, "repositoryId":"twoDayShippingMethod", "excludedCategoriesShippingCharge":[ ], "isFallback":false, "id":"twoDayShippingMethod", "shipToLocations":[ { "repositoryId":"100001" } ], "excludedCategories":[ ] }, { "shippingCalculator":"priceRange", "eligibleForProductWithSurcharges":null, "ranges":[ { "amount":4.5, "high":49.99, "low":0, "repositoryId":"groundRange_01" }, { "amount":8.5, "high":99.99, "low":50, "repositoryId":"groundRange_02" }, { "amount":11, "high":null, "low":100, "repositoryId":"groundRange_03" } ], "associatedPriceListGroups":[ ], "displayName":"Ground", "description":null, "allSites":true, "sites":[ ], "taxCode":null, "type":0, "shippingGroupType":"hardgoodShippingGroup", "enabled":true, "displaySequence":7, "repositoryId":"groundShippingMethod", "excludedCategoriesShippingCharge":[ ], "isFallback":false, "id":"groundShippingMethod", "shipToLocations":[ { "repositoryId":"100001" } ], "excludedCategories":[ ] }, { "shippingCalculator":"priceRange", "eligibleForProductWithSurcharges":null, "isExternallyPriced":false, "ranges":[ { "amount":35, "high":99.99, "low":0, "repositoryId":"overNightRange_01" }, { "amount":45, "high":null, "low":100, "repositoryId":"overNightRange_02" } ], "associatedPriceListGroups":[ ], "displayName":"Overnight", "description":null, "allSites":true, "sites":[ ], "taxCode":"FR020400", "type":0, "shippingGroupType":"hardgoodShippingGroup", "enabled":true, "displaySequence":9, "repositoryId":"overNightShippingMethod", "excludedCategoriesShippingCharge":[ ], "isFallback":false, "id":"overNightShippingMethod", "shipToLocations":[ { "repositoryId":"100001" } ], "excludedCategories":[ ] }, { "shippingCalculator":"external", "eligibleForProductWithSurcharges":true, "estimatedDeliveryDateGuaranteed":false, "internationalDutiesTaxesFees":0, "ranges":[ { "amount":14.95, "high":"179769313486231570000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "low":0 } ], "displayName":"canadapost-overnight", "taxCode":"GT987", "shippingGroupType":"hardgoodShippingGroup", "estimatedDeliveryDate":"2013-04-12 14:48:45 -0400", "enabled":true, "deliveryDays":2, "repositoryId":"canadapost-overnight", "carrierId":"ON" }, { "shippingCalculator":"external", "estimatedDeliveryDateGuaranteed":false, "internationalDutiesTaxesFees":0, "ranges":[ { "amount":33, "high":"179769313486231570000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "low":0 } ], "deliveryDays":2, "displayName":"fedex-2dayground", "repositoryId":"fedex-2dayground", "carrierId":"1D", "taxCode":"TD543", "shippingGroupType":"hardgoodShippingGroup", "estimatedDeliveryDate":"2013-04-12 14:48:45 -0400", "enabled":true } ] } ] } ] }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|31004|Error in Listing Shipping Methods|\n" } }, "parameters":[ { "in":"header", "name":"x-ccsite", "description":"the site id for which the shippping methods are required", "type":"string", "required":false }, { "in":"header", "name":"X-CCOrganization", "description":"the organization Id for which the shipping methdods are required", "type":"string", "required":false }, { "schema":{ "$ref":"#/definitions/listShippingMethods_request" }, "in":"body", "name":"listShippingMethods_request" } ], "tags":[ "Agent/Shipping Methods" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-shippingMethods-post", "x-filename-id":"ccagent-v1-shippingmethods-post" } }, "/ccagent/v1/organizationAddresses":{ "post":{ "summary":"addAddress", "produces":[ "application/json" ], "operationId":"addAddress", "description":"Add Address. This endpoint is used to add addresses of a Organization/Account in Oracle Commerce Cloud. Takes X-CCAgentContext header which is a JSON object with 'shopperProfileId' as a property. If 'shopperProfileId' is not provided, it is considered as an anonymous profile. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value. If this header is not provided, then the endPoint will consider first active organization as the current organization.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/addAddress_response" }, "examples":{ "application/json":{ "address":{ "country":"US", "externalAddressId":"EXT_ADDR_1", "types":[ "ss-10002" ], "phoneNumber":"973-974-1234", "address2":"Street 2", "city":"Montgomery", "address1":"600 Dexter Avenue", "companyName":"National Discount Auto Parts", "postalCode":"36130", "repositoryId":"280004", "state":"AL" }, "addressType":"Montgomery Office Address", "links":[ { "rel":"self", "href":"/ccagentui/v1/organizationAddresses" } ] } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|100183|If input or nickname given is null/empty|\n|100030|Postal Code is required|\n|100031|Country is required|\n|100053|If the organization invalid default billing address value|\n|100032|No State Region is found|\n|100054|If the organization invalid default shipping address value|\n|100076|Invalid Secondary Addresses|\n|82005000|If there is an error while processing the AgentContext header. Possible reasons include invalid profileId, incorrect JSON format or other errors|\n|23015|Phone Number is required|\n|23005|Phone Number is invalid|\n|80018|If an invalid country is provided|\n|100067|If an invalid state is provided|\n|100189|Duplicate Addresses Type are giving in input|\n|100026|Company Name is required|\n|89103|If no shopperProfileId is passed in the AgentContext header|\n|100027|Address 1 is required|\n|89102|If the shopperProfile passed in the AgentContext header or the associated account is inactive|\n|100028|City is required|\n|89101|If the shopperProfile passed in the AgentContext header is not an administrator for the account|\n|100029|State is required|\n|100192|One of the dynamic properties is not writable by the Agent user|\n|180106|One or more address type ID is invalid|\n|" } }, "parameters":[ { "in":"header", "name":"X-CCAsset-Language", "description":"The asset language of the request. E.g., en,de,fr_CA.", "type":"string", "required":false }, { "in":"header", "name":"X-CCOrganization", "description":"the organization Id ", "type":"string", "required":false }, { "in":"header", "name":"X-CCAgentContext", "description":"The Agent Context is a JSON object with shopperProfileId as a property.", "type":"string", "required":true }, { "schema":{ "$ref":"#/definitions/addAddress_request" }, "in":"body", "name":"addAddress_request" } ], "tags":[ "Agent/Organizations Addresses" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-organizationAddresses-post", "x-filename-id":"ccagent-v1-organizationaddresses-post" }, "get":{ "summary":"getAddresses", "produces":[ "application/json" ], "operationId":"getAddresses", "description":"Get Addresses. This operation is used to get all the address of a Organization/Account Oracle Commerce Cloud. Takes X-CCAgentContext header which is a JSON object with 'shopperProfileId' as a property. If 'shopperProfileId' is not provided, it is considered as an anonymous profile.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getAddresses_response" }, "examples":{ "application/json":{ "repositoryId":"or-100001", "name":"National Discount Auto Parts", "active":true, "description":null, "shippingAddress":{ "country":"US", "externalAddressId":"EXT_ADDR_1", "types":[ { "addressType":"Shipping", "repositoryId":"ss-10001" } ], "phoneNumber":"907-385-4412", "address2":null, "city":"Anchorage", "address1":"639 Main St", "companyName":"National Discount Auto Parts", "postalCode":"99501", "repositoryId":"160062", "state":"AZ" }, "secondaryAddresses":[ { "address":{ "country":"US", "externalAddressId":"EXT_ADDR_1", "types":[ { "addressType":"Shipping", "repositoryId":"ss-10001" } ], "phoneNumber":"907-385-4412", "address2":null, "city":"Anchorage", "address1":"639 Main St", "companyName":"National Discount Auto Parts", "postalCode":"99501", "repositoryId":"160062", "state":"AZ" }, "addressType":"Arizona Office Address" }, { "address":{ "country":"US", "types":[ { "addressType":"Shipping", "repositoryId":"ss-10001" } ], "phoneNumber":"631-748-6479", "address2":"Suffolk", "city":"Bohemia", "address1":"70 Euclid Ave #722", "companyName":"National Discount Auto Parts", "postalCode":"11716", "repositoryId":"ci-110024", "state":"NY" }, "addressType":"NewYork Office Address" } ], "links":[ { "rel":"self", "href":"/ccagentui/v1/organizationAddresses" } ], "externalOrganizationId":"EXT_ORG_1", "billingAddress":{ "country":"US", "externalAddressId":"EXT_ADDR_1", "types":[ { "addressType":"Shipping", "repositoryId":"ss-10001" }, { "addressType":"Billing", "repositoryId":"ss-10002" } ], "phoneNumber":"907-385-4412", "address2":null, "city":"Anchorage", "address1":"639 Main St", "companyName":"National Discount Auto Parts", "postalCode":"99501", "repositoryId":"160062", "state":"AZ" }, "id":"or-100001" } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|22010|If no organziation is found|\n|82005000|If there is an error while processing the AgentContext header. Possible reasons include invalid profileId, incorrect JSON format or other errors|\n|89102|If the shopperProfile passed in the AgentContext header or the associated account is inactive|\n" } }, "parameters":[ { "in":"header", "name":"X-CCAsset-Language", "description":"The asset language of the request. E.g., en,de,fr_CA.", "type":"string", "required":false }, { "in":"header", "name":"X-CCOrganization", "description":"the organization Id ", "type":"string", "required":false }, { "in":"header", "name":"X-CCAgentContext", "description":"The Agent Context is a JSON object with shopperProfileId as a property.", "type":"string", "required":true } ], "tags":[ "Agent/Organizations Addresses" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-organizationAddresses-get", "x-filename-id":"ccagent-v1-organizationaddresses-get" } }, "/ccagent/v1/orders/checkRequiresApproval":{ "post":{ "summary":"checkRequiresApproval", "produces":[ "application/json" ], "operationId":"checkRequiresApproval", "description":"Check Requires Approval. Check for an order if it requires an approval or not. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value. If this header is not provided, then the endPoint will consider first active organization as the current organization for a B2B user.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/checkRequiresApproval_response" }, "examples":{ "application/json":{ "requiresApproval":"True", "requireApprovalReasons":"Order is pending approval because total is greater than the approved order limit." } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|100094|Organization passed in the header is currently inactive|\n|100095|The order or return request does not belong to the current organization of the shopper profile|\n|100096|The organization associated to the order or return request was deleted / does not exist|\n|100097|The organization associated to the order or return request is currently inactive|\n|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|\n|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|\n|100101|The shopper profile does not belong to organization passed in the header|\n" } }, "parameters":[ { "in":"header", "name":"X-CCSite", "description":"the site Id in which order should be created", "type":"string", "required":false }, { "in":"header", "name":"X-CCOrganization", "description":"the organization Id in which order should be created", "type":"string", "required":false }, { "schema":{ "$ref":"#/definitions/checkRequiresApproval_request" }, "in":"body", "name":"checkRequiresApproval_request" } ], "tags":[ "Agent/Orders" ], "x-internal-id":"ccagent-v1-orders-checkRequiresApproval-post", "x-filename-id":"ccagent-v1-orders-checkrequiresapproval-post" } }, "/ccagent/v1/scheduledOrders/{id}":{ "get":{ "summary":"getScheduledOrder", "produces":[ "application/json" ], "operationId":"getScheduledOrder", "description":"Get Scheduled Order. Loads a scheduled order details from the repository. Maps all required fields for scheduled order details. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getScheduledOrder_response" }, "examples":{ "application/json":{ "lastError":null, "endDate":"2016-12-08T00:00:00.000Z", "executionStatusList":[ { "errorMessages":[ "Exception While cloning an order." ], "scheduledOrderId":"sco1001", "orderId":null, "repositoryId":"600005", "executionDate":"2016-11-23T00:00:00.000Z", "currency":"USD", "id":"600005", "orderSubmitted":false, "orderTotal":null } ], "type":"scheduledOrder", "version":25, "lastScheduledRun":"2016-11-23T00:00:00.000Z", "schedule":{ "daysInMonth":[ ], "weeksInMonth":[ ], "monthsInYear":[ 1, 3, 5, 7, 9, 11 ], "daysOfWeek":[ ], "occurrenceInDay":1 }, "templateOrderId":"o30414", "clonedOrders":[ ], "profileId":"120939", "templateOrder":{ "totalAmountAuthorized":0, "creationTime":"1479726890000", "orderComments":[ ], "dynamicProperties":[ ], "stateString":"TEMPLATE", "submittedDate":null, "paymentGroups":[ { "PONumber":"", "paymentGroupId":"pg30412", "paymentStateString":"INITIAL", "amountAuthorized":0, "amount":51.7, "totalDue":51.7, "billingAddress":{ "lastName":"Shankar", "country":"US", "address3":"", "address2":"E", "city":"Tempe", "prefix":"", "address1":"S", "postalCode":"36123", "companyName":"", "jobTitle":"", "county":"", "suffix":"", "firstName":"Shiva", "phoneNumber":"909090090", "stateName":"Alabama", "faxNumber":"", "alias":null, "middleName":"", "state":"AL", "countryName":"United States", "email":"s@example.com" }, "paymentState":0, "type":"invoice", "paidAmount":0, "refundAmount":0 } ], "priceInfo":{ "amount":21.99, "total":51.7, "shipping":25, "shippingSurchargeValue":0, "tax":4.71, "subTotal":21.99, "currencyCode":"USD", "totalWithoutTax":46.99 }, "pricingMessages":{ }, "paymentGroup":{ "PONumber":"", "paymentGroupId":"pg30412", "paymentStateString":"INITIAL", "amountAuthorized":0, "amount":51.7, "totalDue":51.7, "billingAddress":{ "lastName":"Shankar", "country":"US", "address3":"", "address2":"E", "city":"Tempe", "prefix":"", "address1":"S", "postalCode":"36123", "companyName":"", "jobTitle":"", "county":"", "suffix":"", "firstName":"Shiva", "phoneNumber":"909090090", "stateName":"Alabama", "faxNumber":"", "alias":null, "middleName":"", "state":"AL", "countryName":"United States", "email":"s@example.com" }, "paymentState":0, "type":"invoice", "paidAmount":0, "refundAmount":0 }, "shoppingCart":{ "items":[ { "unitPrice":21.99, "quantity":1, "productId":"Product_36Exy", "rawTotalPrice":21.99, "returnedQuantity":0, "salePrice":0, "detailedItemPriceInfo":[ { "discounted":false, "amount":21.99, "quantity":1, "tax":2.2, "orderDiscountShare":0, "detailedUnitPrice":21.99, "currencyCode":"USD" } ], "displayName":"The Girl with the Dragon Tattoo", "shippingSurchargeValue":0, "giftWithPurchaseCommerceItemMarkers":[ ], "discountAmount":0, "imageInfo":{ "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v3838394227481959246/products/girldragontattoo_LARGE.jpg&height=100&width=100" }, "tax":2.2, "catRefId":"Sku_36Fxy", "discountInfo":[ ], "price":21.99, "variant":[ ], "onSale":false, "stateDescription":"INITIAL", "listPrice":21.99, "stateDetailsAsUser":"Added to order", "status":0 } ] }, "id":"o30414", "state":4001, "stateDetailsAsUser":"Scheduled order template", "taxPriceInfo":{ "cityTax":1.65, "amount":4.71, "valueAddedTax":0, "countyTax":1.1800000000000002, "isTaxIncluded":false, "miscTax":0, "districtTax":0, "stateTax":1.88, "countryTax":0 }, "shippingGroups":[ { "taxPriceInfo":{ "cityTax":1.65, "amount":4.71, "valueAddedTax":0, "countyTax":1.1800000000000002, "isTaxIncluded":false, "miscTax":0, "districtTax":0, "stateTax":1.88, "countryTax":0 }, "shippingMethod":{ "shippingTax":2.51, "cost":25, "displayName":"Standard", "value":"standardShippingMethod", "shippingMethodDescription":"Standard" }, "shippingGroupId":"sg40414", "submittedDate":null, "priceInfo":{ "amount":21.99, "total":51.7, "shipping":25, "shippingSurchargeValue":0, "tax":4.71, "subTotal":21.99, "currencyCode":"USD", "totalWithoutTax":46.99 }, "discountInfo":{ "orderDiscount":0, "shippingDiscount":0, "discountDescList":[ ] }, "shipOnDate":null, "trackingInfo":[ ], "actualShipDate":null, "shippingAddress":{ "lastName":"Shankar", "country":"US", "address3":"", "address2":"E", "city":"Tempe", "prefix":"", "address1":"S", "postalCode":"36123", "companyName":"", "jobTitle":"", "county":"", "suffix":"", "firstName":"Shiva", "phoneNumber":"909090090", "stateName":"Alabama", "faxNumber":"", "alias":"Address", "middleName":"", "state":"AL", "countryName":"United States", "email":"s@example.com" }, "items":[ { "unitPrice":21.99, "primaryImageTitle":"The Girl with the Dragon Tattoo", "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v3838394227481959246/products/girldragontattoo_LARGE.jpg&height=100&width=100", "quantity":1, "productId":"Product_36Exy", "rawTotalPrice":21.99, "returnedQuantity":0, "salePrice":0, "detailedItemPriceInfo":[ { "discounted":false, "amount":21.99, "quantity":1, "tax":2.2, "orderDiscountShare":0, "detailedUnitPrice":21.99, "currencyCode":"USD" } ], "displayName":"The Girl with the Dragon Tattoo", "shippingSurchargeValue":0, "discountAmount":0, "active":true, "catRefId":"Sku_36Fxy", "discountInfo":[ ], "route":"/product/Product_36Exy", "price":21.99, "variant":[ ], "onSale":false, "primaryImageAltText":"The Girl with the Dragon Tattoo", "stateDetailsAsUser":"The item has been initialized within the shipping group", "listPrice":21.99, "status":"INITIAL" } ], "trackingNumber":null, "status":"INITIAL" } ], "shippingMethod":{ "shippingTax":2.51, "cost":25, "displayName":"Standard", "value":"standardShippingMethod", "shippingMethodDescription":"Standard" }, "profile":{ "firstName":"Shiv", "lastName":"Shankar", "middleName":null, "email":"s@example.com" }, "priceListGroup":{ "deleted":false, "displayName":"Default Price Group", "repositoryId":"defaultPriceGroup", "listPriceList":{ "repositoryId":"listPrices" }, "active":true, "salePriceList":{ "repositoryId":"salePrices" }, "currency":{ "symbol":"$", "displayName":"US Dollar", "repositoryId":"en_US", "fractionalDigits":2, "currencyCode":"USD", "numericCode":"840" }, "id":"defaultPriceGroup", "locale":"en_US", "shippingSurchargePriceList":{ "repositoryId":"shippingSurchargePrices" } }, "returnRequests":[ ], "creationDate":"2016-11-21T11:14:50.000Z", "discountInfo":{ "unclaimedCouponMultiPromotions":{ }, "orderCouponsMap":{ }, "orderDiscount":0, "shippingDiscount":0, "orderImplicitDiscountList":[ ], "unclaimedCouponsMap":{ }, "claimedCouponMultiPromotions":{ } }, "orderCancelReason":null, "profileId":"120939", "exchangeRequests":[ ], "giftWithPurchaseInfo":[ ], "shippingAddress":{ "lastName":"Shankar", "country":"US", "address3":"", "address2":"E", "city":"Tempe", "prefix":"", "address1":"S", "postalCode":"36123", "companyName":"", "jobTitle":"", "county":"", "suffix":"", "firstName":"Shiva", "phoneNumber":"909090090", "stateName":"Alabama", "faxNumber":"", "alias":"Address", "middleName":"", "state":"AL", "countryName":"United States", "email":"s@example.com" }, "giftWithPurchaseOrderMarkers":[ ] }, "repositoryId":"sco10002", "name":"Monthly Order", "siteId":"siteUS", "nextScheduledRun":"1969-12-31T23:59:59.999Z", "links":[ { "rel":"self", "href":"http://localhost:9080/ccagentui/v1/scheduledOrders/sco10002" } ], "state":"active", "id":"sco10002", "startDate":"2016-12-01T00:00:00.000Z", "createDate":"2016-11-21T11:15:15.000Z" } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response. In case of any failure in external tax or external shipping webhooks, the errors returned in the webhook response payload get added to the errors property in this endpoint???s error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|100094|Organization passed in the header is currently inactive|\n|100095|The order or return request does not belong to the current organization of the shopper profile|\n|100096|The organization associated to the order or return request was deleted / does not exist|\n|100097|The organization associated to the order or return request is currently inactive|\n|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|\n|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|\n|100101|The shopper profile does not belong to organization passed in the header|\n|100102|Organization passed in the header is invalid or does not exist|\n" } }, "parameters":[ { "in":"query", "name":"orderDetails", "description":"The flag indicating whether to fetch the template order details.", "type":"boolean", "required":false }, { "in":"header", "name":"X-CCOrganization", "description":"The organization Id to which the order belongs", "type":"string", "required":false }, { "in":"path", "name":"id", "description":"ID of the scheduled order to be retrieved.", "type":"string", "required":true } ], "tags":[ "Agent/Scheduled Orders" ], "x-internal-id":"ccagent-v1-scheduledOrders-{id}-get", "x-filename-id":"ccagent-v1-scheduledorders-id-get" }, "delete":{ "summary":"deleteScheduledOrder", "produces":[ "application/json" ], "operationId":"deleteScheduledOrder", "description":"Delete Scheduled Order. Deletes the scheduled order. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value.", "responses":{ "200":{ "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|100094|Organization passed in the header is currently inactive|\n|100095|The order or return request does not belong to the current organization of the shopper profile|\n|100096|The organization associated to the order or return request was deleted / does not exist|\n|100097|The organization associated to the order or return request is currently inactive|\n|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|\n|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|\n|100101|The shopper profile does not belong to organization passed in the header|\n" } }, "parameters":[ { "in":"header", "name":"X-CCOrganization", "description":"The organization Id to which the order belongs", "type":"string", "required":false }, { "in":"path", "name":"id", "description":"ID of the scheduled order to be deleted.", "type":"string", "required":true } ], "tags":[ "Agent/Scheduled Orders" ], "x-internal-id":"ccagent-v1-scheduledOrders-{id}-delete", "x-filename-id":"ccagent-v1-scheduledorders-id-delete" }, "put":{ "summary":"updateScheduledOrder", "produces":[ "application/json" ], "operationId":"updateScheduledOrder", "description":"Update Scheduled Order. Updates the scheduled order. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/updateScheduledOrder_response" }, "examples":{ "application/json":{ "lastError":null, "endDate":"2016-12-08T00:00:00.000Z", "executionStatusList":[ { "errorMessages":[ "Exception While cloning an order." ], "orderId":null, "repositoryId":"600005", "executionDate":"2016-11-23T00:00:00.000Z", "id":"600005", "orderSubmitted":false, "orderTotal":null } ], "type":"scheduledOrder", "version":25, "lastScheduledRun":"2016-11-23T00:00:00.000Z", "schedule":{ "daysInMonth":[ ], "weeksInMonth":[ ], "monthsInYear":[ 1, 3, 5, 7, 9, 11 ], "daysOfWeek":[ ], "occurrenceInDay":1 }, "templateOrderId":"o30414", "clonedOrders":[ ], "profileId":"120939", "repositoryId":"sco10002", "name":"Monthly Order", "siteId":"siteUS", "nextScheduledRun":"1969-12-31T23:59:59.999Z", "links":[ { "rel":"self", "href":"http://localhost:9080/ccagentui/v1/scheduledOrders/sco10002" } ], "state":"active", "id":"sco10002", "startDate":"2016-12-01T00:00:00.000Z", "createDate":"2016-11-21T11:15:15.000Z" } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|100094|Organization passed in the header is currently inactive|\n|100095|The order or return request does not belong to the current organization of the shopper profile|\n|100096|The organization associated to the order or return request was deleted / does not exist|\n|100097|The organization associated to the order or return request is currently inactive|\n|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|\n|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|\n|100101|The shopper profile does not belong to organization passed in the header|\n" } }, "parameters":[ { "in":"header", "name":"X-CCOrganization", "description":"The organization Id to which the order belongs", "type":"string", "required":false }, { "in":"path", "name":"id", "description":"ID of the scheduled order to be updated.", "type":"string", "required":true }, { "schema":{ "$ref":"#/definitions/updateScheduledOrder_request" }, "in":"body", "name":"updateScheduledOrder_request" } ], "tags":[ "Agent/Scheduled Orders" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-scheduledOrders-{id}-put", "x-filename-id":"ccagent-v1-scheduledorders-id-put" } }, "/ccagent/v1/orders/submitCancelOrder":{ "put":{ "summary":"submitCancelOrder", "produces":[ "application/json" ], "operationId":"submitCancelOrder", "description":"This is used to submit the cancel order.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/submitCancelOrder_response" }, "examples":{ "application/json":{ "orderCancelled":true, "orderId":"o10004" } }, "description":"Following result is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response" } }, "parameters":[ { "in":"header", "name":"X-CCOrganization", "description":"Current organization context of the logged in user", "type":"string", "required":false }, { "in":"header", "name":"X-CCAgentContext.shopperProfileId", "description":"the profile id from which the order was placed", "type":"string", "required":true }, { "in":"header", "name":"x-ccsite", "description":"the site id on which the orders needs to be placed", "type":"string", "required":true }, { "schema":{ "$ref":"#/definitions/submitCancelOrder_request" }, "in":"body", "name":"submitCancelOrder_request" } ], "tags":[ "Agent/Orders" ], "x-internal-id":"ccagent-v1-orders-submitCancelOrder-put", "x-filename-id":"ccagent-v1-orders-submitcancelorder-put" } }, "/ccagent/v1/files/{id}":{ "post":{ "summary":"doFileSegmentUpload", "produces":[ "application/json" ], "operationId":"doFileSegmentUpload", "description":"Do File Segment Upload. Upload a segment as part of a resumable file upload. Requires a token obtained from startFileUpload or resumeFileUpload. Note that all responses except for the response to the last segment will only have a success property (no result property).", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/doFileSegmentUpload_response" }, "examples":{ "application/json":{ "success":true } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|413|Please upload a file smaller than one GB|\n|13004|The token value is missing for this upload|\n|13005|Could not save file segment for unknown filename. The startUpload() or resumeUpload() method must be called before uploading individual file segments|\n|13014|Missing required property: {0}|\n|20306|The filename is invalid|\n|13006|The token value for this upload is no longer valid. Discontinue upload attempts for segments of this file|\n" } }, "parameters":[ { "in":"path", "name":"id", "description":"ID of file to be uploaded which is same as token value.", "type":"string", "required":true }, { "schema":{ "$ref":"#/definitions/doFileSegmentUpload_request" }, "in":"body", "name":"doFileSegmentUpload_request" } ], "tags":[ "Agent/Files" ], "x-internal-id":"ccagent-v1-files-{id}-post", "x-filename-id":"ccagent-v1-files-id-post" }, "get":{ "summary":"getFile", "produces":[ "*/*" ], "operationId":"getFile", "description":"Get File. Get a file by ID. Returns the file. Optionally takes the x-ccasset-language header to get translated content in another language.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getFile_response" }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response" } }, "parameters":[ { "in":"header", "name":"X-CCAsset-Language", "description":"The asset language of the request", "type":"string", "required":false }, { "in":"path", "name":"id", "description":"ID of the file. The id is the name of the file example agent-main.js", "type":"string", "required":true } ], "tags":[ "Agent/Files" ], "x-internal-id":"ccagent-v1-files-{id}-get", "x-filename-id":"ccagent-v1-files-id-get" } }, "/ccagent/v1/metadata-catalog":{ "get":{ "summary":"getMetadataCatalog", "produces":[ "application/json", "application/swagger+json" ], "operationId":"getMetadataCatalog", "description":"Get Metadata Catalog. Returns metadata catalog. Returns Swagger metadata catalog when 'Accept' request header is specified as 'application/swagger+json' else will return json hyper schema docs. The **JSON hyper schema** being served is **deprecated**. Use Swagger.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getMetadataCatalog_response" }, "examples":{ "application/swagger+json":{ "basePath":"/ccagent/v1", "paths":{ "/metadata/{id}":{ "get":{ "summary":"getMetadata", "produces":[ "application/json" ], "operationId":"getMetadata", "description":"Get Metadata. Get the metadata information for an item descriptor by ID.", "responses":{ "200":{ "description":"Following model is returned when operation succeeds." } }, "parameters":[ { "in":"path", "name":"id", "description":"The ID of the itemType.", "type":"string", "required":true } ], "tags":[ "Metadata" ] } } }, "definitions":{ "getMetadata_response":{ "properties":{ "items":{ "description":"An array of metadata/ properties information for an item descriptor.", "type":"array", "items":{ "type":"object", "properties":{ "editableAttributes":{ "description":"List of attributes of the property which can be edited from UI.", "type":"array", "items":{ "type":"string" } } } } } } } }, "swagger":"2.0", "info":{ "description":"Metadata endpoints", "title":"Metadata", "version":"1.0" } } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|13101|METADATA INTERNAL ERROR|\n" } }, "tags":[ "Agent/Agent Metadata Catalog" ], "x-internal-id":"ccagent-v1-metadata-catalog-get", "x-filename-id":"ccagent-v1-metadata-catalog-get" } }, "/ccagent/v1/orders/{id}/shippingGroups/{sgId}/pickupItems":{ "post":{ "summary":"pickupItems", "produces":[ "application/json" ], "operationId":"pickupItems", "description":"Updates the given shipping group for the given order to indicate the items in the shipping group have been picked up.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/updateOrder_response" }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response" } }, "parameters":[ { "in":"path", "name":"id", "description":"The ID of the order being picked up.", "type":"string", "required":true }, { "in":"path", "name":"sgId", "description":"The ID of the shipping group being picked up.", "type":"string", "required":true } ], "tags":[ "Agent/Orders" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-orders-{id}-shippingGroups-{sgId}-pickupItems-post", "x-filename-id":"ccagent-v1-orders-id-shippinggroups-sgid-pickupitems-post" } }, "/ccagent/v1/saml/sso":{ "post":{ "summary":"single sign on", "produces":[ "application/json" ], "operationId":"singleSignOn", "description":"Single Sign On", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/singleSignOn_request" }, "examples":{ "application/json":{ "access_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MTQxNDk5NTYsInN1YiI6IjExMDU1OCIsImlzcyI6InN0b3JlZnJvbnRVSSIsImlhdCI6MTQxNDE0OTAyNn0=.B9qM0/VKpCNKvjCmOnUPv4RS7mkIDgKcP8RJPaVQGYU=", "token_type":"bearer", "expires_in":930 } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|51301|Internal Error.|\n" } }, "parameters":[ { "schema":{ "$ref":"#/definitions/singleSignOn_request" }, "in":"body", "name":"singleSignOn_request" } ], "tags":[ "Agent/Agent Single Sign On" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-saml-sso-post", "x-filename-id":"ccagent-v1-saml-sso-post" } }, "/ccagent/v1/orders/{id}":{ "post":{ "summary":"handleOrderActions", "produces":[ "application/json" ], "operationId":"handleOrderActions", "description":"Handle Order Actions. It handles the order actions based on Op value. Op value can be any of cancel/validateOrder/validatePaymentAuthorization/validActions/invalidateOrder/sendPlacedOrderEmailNotification. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value. If this header is not provided, then the endPoint will consider first active organization as the current organization for a B2B user.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/handleOrderActions_response" }, "examples":{ "application/json":{ "links":[ { "rel":"self", "href":"/ccagentui/v1/orders/o10008" } ], "id":"o10008", "message":"Order [o10008] has been successfully cancelled." } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|100094|Organization passed in the header is currently inactive|\n|100095|The order or return request does not belong to the current organization of the shopper profile|\n|100096|The organization associated to the order or return request was deleted / does not exist|\n|100097|The organization associated to the order or return request is currently inactive|\n|200219|{0} is an inactive reason.|\n|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|\n|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|\n|200218|{0} is an invalid reason.|\n|200101|Cancel failed as order is in [{0}] state.|\n|200104|The shipping group commerce item relationship [{0}] is in an invalid [{1}] state.|\n|200103|The shipping group [{0}] is in a no pending action state.|\n|30015|SiteId passed in x-ccsite header is currently inactive|\n|200100|Internal error occurred while processing the request.|\n|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|\n|30020|The Site to which the order belongs was deleted|\n|30021|The Site to which the order belongs is currently inactive|\n|100101|The shopper profile does not belong to organization passed in the header|\n|30019|SiteId passed in x-ccsite header is not related to the order being worked upon|\n|210105|Specified order does not exist.|\n" } }, "parameters":[ { "in":"header", "name":"X-CCOrganization", "description":"the organization Id in which order should be created", "type":"string", "required":false }, { "in":"path", "name":"id", "description":"Commerce id of order.", "type":"string", "required":true }, { "schema":{ "$ref":"#/definitions/handleOrderActions_request" }, "in":"body", "name":"handleOrderActions_request" } ], "tags":[ "Agent/Orders" ], "x-internal-id":"ccagent-v1-orders-{id}-post", "x-filename-id":"ccagent-v1-orders-id-post" }, "get":{ "summary":"getOrder", "produces":[ "application/json" ], "operationId":"getOrder", "description":"Get Order. Loads an order details from the repository. Maps all required fields for order details. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value. If this header is not provided, then the endPoint will consider first active organization as the current organization for a B2B user.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getOrder_response" }, "examples":{ "application/json":{ "totalAmountAuthorized":124.18, "agentId":"service", "orderComments":[ ], "creationTime":"1436906449000", "sourceSystem":"Cloud Commerce", "dynamicProperties":[ { "id":"dynamicPropertyShippingInstructions", "value":"Test Instructions" } ], "submittedDate":"2015-07-14T20:41:49.000Z", "paymentGroups":[ { "lastName":"Anderson", "amountAuthorized":124.18, "amount":88.55, "totalDue":88.55, "cardType":null, "zero_value_auto_authorized":"true", "IIN":"424242", "token":"9997000108950573", "paymentGroupId":"pg10411", "firstName":"Kim", "paymentStateDetailsAsUser":"The authorization succeeded", "uiIntervention":"sop", "billingAddress":{ "lastName":"Anderson", "country":"US", "address3":null, "address2":null, "city":"Syracuse", "address1":"21 Cedar Ave", "prefix":null, "companyName":null, "postalCode":"13202", "jobTitle":null, "county":null, "suffix":null, "selectedCountry":"US", "firstName":"Kim", "phoneNumber":"212-555-1977", "stateName":"New York", "faxNumber":null, "middleName":null, "countryName":"United States", "state":"NY", "email":"kim@example.com", "selectedState":"NY", "state_ISOCode":"US-NY" }, "paymentState":1, "paidAmount":0, "cardNumber":"xxxxxxxxxxxx1111", "refundAmount":0 } ], "priceInfo":{ "amount":56.99, "total":88.55, "shipping":25, "shippingSurchargeValue":0, "tax":6.56, "subTotal":56.99, "currencyCode":"USD" }, "submissionProgress":[ ], "paymentGroup":{ "lastName":"Anderson", "amountAuthorized":124.18, "amount":88.55, "totalDue":88.55, "cardType":null, "zero_value_auto_authorized":"true", "token":"9997000108950573", "paymentGroupId":"pg10411", "firstName":"Kim", "paymentStateDetailsAsUser":"The authorization succeeded", "uiIntervention":"sop", "billingAddress":{ "lastName":"Anderson", "country":"US", "address3":null, "address2":null, "city":"Syracuse", "address1":"21 Cedar Ave", "prefix":null, "companyName":null, "postalCode":"13202", "jobTitle":null, "county":null, "suffix":null, "selectedCountry":"US", "firstName":"Kim", "phoneNumber":"212-555-1977", "stateName":"New York", "faxNumber":null, "middleName":null, "countryName":"United States", "state":"NY", "email":"kim@example.com", "selectedState":"NY", "state_ISOCode":"US-NY" }, "paymentState":1, "paidAmount":0, "cardNumber":"xxxxxxxxxxxx1111", "refundAmount":0 }, "shoppingCart":{ "items":[ { "deactivationDate":"2018-06-27T12:59:59Z", "rawTotalPrice":39.99, "returnedQuantity":0, "priceOverridenBy":"Damon Weber", "displayName":"Fable II", "shippingSurchargeValue":0, "discountAmount":0, "externalData":[ ], "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "imageInfo":{ "primaryThumbImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/fableIIxbox_LARGE.jpg&height=100&width=100" }, "preOrderQuantity":0, "childItems":[ { "commerceItemId":"ci19000424", "configurationOptionId":"co40001", "addOnItem":true, "quantity":1, "route":"/intel-pentium-dual-core/product/prod40001", "productId":"prod40001", "displayName":"Intel Pentium Dual Core", "selectedOptions":[ ], "siteId":"siteUS", "childItems":[ { "commerceItemId":"ci19000424", "addOnItem":false, "quantity":1, "route":"/intel-pentium-dual-core/product/prod40001", "productId":"prod40001", "displayName":"Intel Pentium Dual Core", "selectedOptions":[ ], "siteId":"siteUS", "catRefId":"sku40009" } ], "configurablePropertyId":"cp40001", "catRefId":"sku40001" }, { "commerceItemId":"ci19000426", "addOnItem":false, "quantity":1, "route":"/8-gb-kingston-sodimm-ddr3-1600mhz/product/prod40007", "productId":"prod40007", "displayName":"8 GB Kingston Sodimm DDR3 1600MHz", "selectedOptions":[ ], "siteId":"siteUS", "catRefId":"sku40007" }, { "commerceItemId":"ci19000425", "configurationOptionId":"confO_12", "addOnItem":true, "quantity":1, "productId":"prod12344", "displayName":"Gift Wrap", "siteId":"siteUS", "shopperInput":{ "color":"neon", "message":"Happy Birthday My Friend", "font":"courier" }, "configurablePropertyId":"conf022", "catRefId":"sku12344" } ], "configuratorId":"36379716", "assetKey":"12345", "overriddenPrice":3, "commerceItemId":"ci1000785", "price":3, "isPriceOverridden":true, "variant":[ ], "onSale":"true", "actionCode":"Add", "serviceId":"service-123", "locationInventoryInfoMap":{ }, "stateDetailsAsUser":"The item has been initialized", "serviceAccountId":"serviceAcc-123", "unitPrice":39.99, "quantity":1, "productId":"prod10041", "parentAssetKey":null, "originalCommerceItemId":null, "tax":0.34, "rootAssetKey":null, "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"sku10045", "skuProperties":[ { "propertyType":"sku-base", "name":"Name", "id":"displayName", "value":null }, { "propertyType":"sku-base", "name":"Id", "id":"id", "value":"camerasku_1_1" }, { "propertyType":"sku-custom", "name":"dynamicskuprop1", "id":"dynamicskuprop1", "value":"dynamicskuprop1" } ], "customerAccountId":"customerAcc-123", "discountInfo":[ ], "siteId":"siteUS", "activationDate":"2017-06-27T15:30:00Z", "asset":false, "backOrderQuantity":0, "listPrice":39.99, "status":0, "priceOverrideReason":{ "displayValue":"Agent Price Override", "key":"agentPriceOverride" } }, { "deactivationDate":"2018-06-27T12:59:59Z", "rawTotalPrice":49.99, "returnedQuantity":0, "priceOverridenBy":"", "displayName":"Dora the Explorer - Season 1", "shippingSurchargeValue":0, "discountAmount":0, "externalData":[ ], "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "imageInfo":{ "primaryThumbImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/doratheexplorer_season1_LARGE.jpg&height=100&width=100" }, "assetKey":"23456", "overriddenPrice":"", "price":49.99, "isPriceOverridden":false, "variant":[ ], "actionCode":"Add", "serviceId":"service-123", "stateDetailsAsUser":"The item has been initialized", "unitPrice":49.99, "serviceAccountId":"serviceAcc-123", "quantity":1, "productId":"Product_21Cxi", "parentAssetKey":null, "originalCommerceItemId":null, "tax":5.75, "rootAssetKey":null, "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"Sku_21Dxy", "customerAccountId":"customerAcc-123", "discountInfo":[ ], "siteId":"siteUS", "activationDate":"2017-06-27T15:30:00Z", "asset":false, "listPrice":49.99, "status":0, "priceOverrideReason":{ } }, { "deactivationDate":"2018-06-27T12:59:59Z", "rawTotalPrice":49.98, "returnedQuantity":0, "priceOverridenBy":"Damon Weber", "displayName":"Akira", "shippingSurchargeValue":0, "discountAmount":0, "externalData":[ ], "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "imageInfo":{ "primaryThumbImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/akira_LARGE.jpg&height=100&width=100" }, "assetKey":"12345", "overriddenPrice":4, "price":4, "isPriceOverridden":true, "variant":[ ], "actionCode":"Add", "serviceId":"service-123", "stateDetailsAsUser":"The item has been initialized", "unitPrice":24.99, "serviceAccountId":"serviceAcc-123", "quantity":2, "productId":"Product_27Fxyzi", "giftWithPurchaseCommerceItemMarkers":[ ], "parentAssetKey":null, "originalCommerceItemId":null, "tax":0.46, "rootAssetKey":null, "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"Sku_27Gxyzi", "customerAccountId":"customerAcc-123", "discountInfo":[ ], "siteId":"siteUS", "activationDate":"2017-06-27T15:30:00Z", "asset":false, "listPrice":24.99, "status":0, "priceOverrideReason":{ "displayValue":"Appeasement", "key":"appeasement" } } ] }, "additionalEmails":[ "w.rubble@bedrock.com", "w.flintstone@bedrock.com" ], "links":[ { "rel":"self", "href":"http://localhost:9080/ccagentui/v1/orders/o10411?includeResult=full" } ], "state":1, "id":"o10411", "stateDetailsAsUser":"Submitted to fulfillment", "taxPriceInfo":{ "cityTax":0, "amount":4, "valueAddedTax":0, "countyTax":2, "isTaxIncluded":false, "miscTax":0, "districtTax":0, "stateTax":2, "countryTax":0 }, "shippingGroups":[ { "trackingInfo":[ ], "locationId":"SiteUS-GlenAllen187", "shippingMethod":{ "cost":25, "displayName":"Standard", "value":"standardShippingMethod" }, "shippingAddress":{ "lastName":"Anderson", "country":"US", "address3":null, "address2":null, "city":"Syracuse", "address1":"21 Cedar Ave", "prefix":null, "companyName":null, "postalCode":"13202", "jobTitle":null, "county":null, "suffix":null, "selectedCountry":"US", "firstName":"Kim", "phoneNumber":"212-555-1977", "stateName":"New York", "faxNumber":null, "middleName":null, "countryName":"United States", "state":"NY", "email":"kim@example.com", "selectedState":"NY", "state_ISOCode":"US-NY" }, "commerceItemRelationships":[ { "commerceItemId":"ci1000785", "inventoryLocationId":null, "amount":0, "quantity":1, "relationshipType":"SHIPPINGQUANTITY", "returnedQuantity":0, "range":{ "lowBound":0, "highBound":0, "size":1 }, "commerceItemExternalId":null, "state":"INITIAL", "id":"r50387" } ], "trackingNumber":null, "items":[ { "serviceAccountId":"serviceAcc-123", "deactivationDate":"2018-06-27T12:59:59Z", "quantity":1, "pointOfNoRevision":false, "relationshipType":"SHIPPINGQUANTITY", "productId":"Product_21Cxi", "externalData":[ ], "parentAssetKey":null, "billingProfileId":"billingProfile-123", "billingAccountId":"billingAcc-123", "preOrderQuantity":0, "rootAssetKey":null, "transactionDate":"2018-06-27T12:59:59Z", "catRefId":"Sku_21Dxy", "assetKey":"34567", "skuProperties":[ { "propertyType":"sku-base", "name":"Name", "id":"displayName", "value":null }, { "propertyType":"sku-base", "name":"Id", "id":"id", "value":"camerasku_1_1" }, { "propertyType":"sku-custom", "name":"dynamicskuprop1", "id":"dynamicskuprop1", "value":"dynamicskuprop1" } ], "customerAccountId":"customerAcc-123", "variant":[ ], "actionCode":"Add", "activationDate":"2017-06-27T15:30:00Z", "serviceId":"service-123", "asset":false, "backOrderQuantity":0, "locationInventoryInfoMap":{ } } ] } ], "creationSiteId":"siteUS", "approvalSystemMessages":[ "Order is pending approval because total is greater than the approved order limit." ], "shippingMethod":{ "cost":25, "displayName":"Standard", "value":"standardShippingMethod" }, "isItemPriceOverrideAllowed":true, "profile":{ "lastName":"Anderson", "firstName":"Kim", "organization":{ "name":"Oracle India Pvt Ltd", "id":"oracle" }, "middleName":null, "email":"kim@example.com" }, "priceListGroup":{ "deleted":false, "displayName":"UsDollar", "repositoryId":"UsDollar", "active":true, "currency":{ "symbol":"$", "displayName":"US Dollar", "repositoryId":"en_US", "fractionalDigits":2, "currencyCode":"USD", "numericCode":"840" }, "id":"UsDollar", "locale":"en_US" }, "cartName":"o10411", "returnRequests":[ ], "creationDate":"2015-07-14T20:40:49.000Z", "orderAction":"order", "originOfOrder":"contactCenter", "submissionErrorCodes":[ ], "sharedWithOrganization":false, "discountInfo":{ "unclaimedCouponMultiPromotions":{ }, "orderCouponsMap":{ }, "orderDiscount":0, "shippingDiscount":0, "orderImplicitDiscountList":[ ], "unclaimedCouponsMap":{ }, "claimedCouponMultiPromotions":{ } }, "submissionErrorMessages":[ ], "profileId":"se-570031", "exchangeRequests":[ ], "giftWithPurchaseInfo":[ ], "siteId":"siteUS", "shippingAddress":{ "lastName":"Anderson", "country":"US", "address3":null, "address2":null, "city":"Syracuse", "address1":"21 Cedar Ave", "prefix":null, "companyName":null, "postalCode":"13202", "jobTitle":null, "county":null, "suffix":null, "selectedCountry":"US", "firstName":"Kim", "phoneNumber":"212-555-1977", "stateName":"New York", "faxNumber":null, "middleName":null, "countryName":"United States", "state":"NY", "email":"kim@example.com", "selectedState":"NY", "state_ISOCode":"US-NY" }, "markers":[ ], "giftWithPurchaseOrderMarkers":[ ] } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|100094|Organization passed in the header is currently inactive|\n|100095|The order or return request does not belong to the current organization of the shopper profile|\n|100096|The organization associated to the order or return request was deleted / does not exist|\n|100097|The organization associated to the order or return request is currently inactive|\n|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|\n|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|\n|100101|The shopper profile does not belong to organization passed in the header|\n|100102|Organization passed in the header is invalid or does not exist|\n" } }, "parameters":[ { "in":"query", "name":"includeResult", "description":"It is \"full\" if full result is to be included.", "type":"string", "required":false }, { "in":"header", "name":"X-CCOrganization", "description":"the organization Id in which order should be created", "type":"string", "required":false }, { "in":"path", "name":"id", "description":"Commerce id of order.", "type":"string", "required":true } ], "tags":[ "Agent/Orders" ], "x-internal-id":"ccagent-v1-orders-{id}-get", "x-filename-id":"ccagent-v1-orders-id-get" }, "put":{ "summary":"updateOrder", "produces":[ "application/json" ], "operationId":"updateOrder", "description":"Updates the given order with the profileId provided in the query param.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/updateOrder_response" }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response" } }, "parameters":[ { "in":"path", "name":"id", "description":"The ID of the order.", "type":"string", "required":true }, { "in":"query", "name":"profileId", "description":"The customer profile id.", "type":"string", "required":true } ], "tags":[ "Agent/Orders" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-orders-{id}-put", "x-filename-id":"ccagent-v1-orders-id-put" } }, "/ccagent/v1/reasons":{ "get":{ "summary":"listReasons", "produces":[ "application/json" ], "operationId":"listReasons", "description":"List appeasement reasons based on the search criteria entered.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/listReasons_response" }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\nBelow is the list of error codes: \n\n\n|Error Code|Description|\n|------------------|------------------|\n|85000|Invalid SCIM filter format.|\n|85003|Invalid attribute in query|\n|900029|An internal error occured while processing the input request|" } }, "parameters":[ { "in":"query", "name":"q", "description":"Search criteria - Following are the fields supported by this param: \n\n|Field|Type|Description|\n|------------------|------------------|------------------|\n|active|boolean|active flag of the appeasement reason|\n|id|string|id of the appeasement reason|\n|description|string|description of the appeasement reason|\n|readableDescription|string|name of the appeasement reason|\nSearch criteria in SCIM Format should be as: active eq true. \n", "type":"string", "required":true }, { "in":"query", "name":"type", "description":"Type of the reason for which id should be presented. Possible value appeasementReason", "type":"string", "required":true }, { "in":"query", "name":"fields", "description":"This controls which fields are returned in the response body.", "type":"string", "required":false }, { "in":"query", "name":"totalResults", "description":"Indicates if the total results should be included in the response.", "type":"boolean", "required":false }, { "in":"query", "name":"offset", "description":"This field specifies the offset/starting index from which data to be fetched.", "type":"integer", "required":false }, { "in":"query", "name":"limit", "description":"This is the field to specify the number of records to be fetched per REST call.", "type":"integer", "required":false }, { "in":"query", "name":"sort", "description":"This field specifies the sort order of the list to be fetched.", "type":"string", "required":false } ], "tags":[ "Agent/Reasons" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-reasons-get", "x-filename-id":"ccagent-v1-reasons-get" } }, "/ccagent/v1/saml/logoutRequest":{ "get":{ "summary":"get SAML LogoutRequest", "produces":[ "application/json" ], "operationId":"getLogoutRequest", "description":"Get SAML LogoutRequest", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getLogoutRequest_response" }, "examples":{ "application/json":{ "saml_slo_request_dst":"https://localhost/fed/v1/idp/slo", "saml_slo_request":"Base64 encoded SAML LogoutRequest" } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|51301|Internal Error.|\n" } }, "tags":[ "Agent/Agent SAML LogoutRequest" ], "x-internal-id":"ccagent-v1-saml-logoutRequest-get", "x-filename-id":"ccagent-v1-saml-logoutrequest-get" } }, "/ccagent/v1/saml/authnRequest":{ "get":{ "summary":"get SAML AuthnRequest", "produces":[ "application/json" ], "operationId":"getAuthnRequest", "description":"Get SAML AuthnRequest", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getAuthnRequest_response" }, "examples":{ "application/json":{ "saml_sso_request_dst":"https://localhost/fed/v1/idp/sso", "saml_sso_request":"Base64 encoded SAML AuthnRequest" } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|51301|Internal Error.|\n" } }, "parameters":[ { "in":"query", "name":"forceAuthn", "description":"Query String indicated whether the ForceAuthn attribute will be set to either true or false (the default value).", "type":"string", "required":false } ], "tags":[ "Agent/Agent SAML AuthnRequest" ], "x-internal-id":"ccagent-v1-saml-authnRequest-get", "x-filename-id":"ccagent-v1-saml-authnrequest-get" } }, "/ccagent/v1/payment/void":{ "post":{ "summary":"voidPayments", "produces":[ "application/json" ], "operationId":"voidPayments", "description":"Void PaymentGroups of an order.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/voidPayments_response" }, "examples":{ "application/json":{ "orderId":"o50419", "paymentResponses":[ { "paymentGroupId":"pg50414", "customPaymentProperties":{ "sample-addnl-property-key2":"sample-payment-property-value2", "cust-prop2":"cust-prop2", "cust-prop1":"cust-prop1" }, "gatewayName":"PP-A", "paymentMethod":"onlinePaymentGroup", "paymentState":"REMOVED", "message":"" } ] } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|51176|An error occurred canceling payment groups.|\n|51177|An error occurred canceling payment groups.|\n|51178|The cancellation of payment groups is not allowed.|\n|51179|The Payment Group is invalid and does not belong to order.|\n" } }, "parameters":[ { "schema":{ "$ref":"#/definitions/voidPayments_request" }, "in":"body", "name":"voidPayments_request" }, { "in":"query", "name":"includeOrder", "description":"If true, then order will be included in the response.", "type":"boolean", "required":false } ], "tags":[ "Agent/Payment" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-payment-void-post", "x-filename-id":"ccagent-v1-payment-void-post" } }, "/ccagent/v1/profiles/{id}/creditCards":{ "post":{ "summary":"addCreditCard", "produces":[ "application/json" ], "operationId":"addCreditCard", "description":"Add credit card for the shopper. The credit card data is tokenised and is stored against the profile.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/addCreditCard_response" }, "examples":{ "application/json":{ "expiryMonth":"03", "cardType":"visa", "expiryYear":"2021", "iin":"411111", "savedCardId":"usercc10002", "hasExpired":false, "isDefault":true, "customPaymentProperties":{ "addl-prop4":"addl-prop4", "addl-prop3":"addl-prop3", "addl-prop1":"addl-prop1", "decision":null, "reasonCode":null }, "nameOnCard":"card2", "nickname":"Home Card 2", "additionalInfo":null, "links":[ { "rel":"self", "href":"http://localhost:9080/ccagentui/v1/profiles/se-570031/creditCards" } ], "cardNumber":"xxxxxxxxxxxx1111" } }, "description":"Following model is returned when the operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|28396|Provided card details are incorrect.|\n|28397|An error occured while trying to add the credit card.|\n|28398|Tokenisation declined by payment gateway. Error message sent by the gateway will be returned.|\n|28399|Adding credit card is not supported on this site." } }, "parameters":[ { "in":"header", "name":"X-CCAsset-Language", "description":"The asset language of the request.", "type":"string", "required":false }, { "in":"path", "name":"id", "description":"The customer profile id.", "type":"string", "required":true }, { "schema":{ "$ref":"#/definitions/addCreditCard_request" }, "in":"body", "name":"addCreditCard_request" } ], "tags":[ "Agent/Customers" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-profiles-{id}-creditCards-post", "x-filename-id":"ccagent-v1-profiles-id-creditcards-post" }, "get":{ "summary":"listCreditCards", "produces":[ "application/json" ], "operationId":"listCreditCards", "description":"Gets the list of credit cards associated with the shopper and its organization", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/listCreditCards_response" }, "examples":{ "application/json":{ "total":3, "totalResults":3, "offset":0, "limit":250, "links":[ { "rel":"self", "href":"http://localhost:8080/ccstoreui/v1/profiles/{id}}/creditCards?allCards=true&allGateways=true&allSites=true" } ], "items":[ { "savedCardId":"usercc10001", "hasExpired":false, "isDefault":false, "nameOnCard":"card1", "repositoryId":"usercc10001", "expiryMonth":"04", "cardType":"visa", "nickname":"visa - 1111", "additionalInfo":"Card has been synced with id 10001", "expiryYear":"2021", "cardNumber":"xxxxxxxxxxxx1111", "iin":"411111" }, { "savedCardId":"usercc10002", "hasExpired":false, "isDefault":false, "nameOnCard":"card2", "repositoryId":"usercc10002", "expiryMonth":"03", "cardType":"visa", "nickname":"visa - 1111##0", "additionalInfo":"Card has been synced with id 10002", "expiryYear":"2021", "cardNumber":"xxxxxxxxxxxx1111", "iin":"411111" }, { "savedCardId":"usercc10003", "hasExpired":false, "isDefault":true, "nameOnCard":"card3", "repositoryId":"usercc10003", "expiryMonth":"02", "cardType":"visa", "nickname":"visa - 1111##1", "additionalInfo":null, "expiryYear":"2020", "cardNumber":"xxxxxxxxxxxx1111", "iin":"411111" } ] } }, "description":"Following model is returned when the operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commercer Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|28386|An error occurred while retrieving the credit card list.|\n|28387|An error occurred while processing the credit card list.|\n" } }, "parameters":[ { "in":"header", "name":"X-CCAsset-Language", "description":"The asset language of the request.", "type":"string", "required":false }, { "in":"query", "name":"allCards", "description":"This value is set to true, if inactive cards are also expected in the response.", "type":"boolean", "required":false }, { "in":"query", "name":"allGateways", "description":"This value is set to true, if the cards from disabled gateways are also expected in the response.", "type":"boolean", "required":false }, { "in":"query", "name":"allSites", "description":"This value is set to true, if the cards from non-current site are also expected in the response.", "type":"boolean", "required":false }, { "in":"path", "name":"id", "description":"User profile id", "type":"string", "required":true } ], "tags":[ "Agent/Customers" ], "x-internal-id":"ccagent-v1-profiles-{id}-creditCards-get", "x-filename-id":"ccagent-v1-profiles-id-creditcards-get" } }, "/ccagent/v1/appeasements/{id}":{ "get":{ "summary":"getAppeasement", "produces":[ "application/json" ], "operationId":"getAppeasement", "description":"Get Appeasement. Gets a detailed appeasement information based on the appeasement ID provided.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getAppeasement_response" }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|900001|An internal error occurred while processing input request.|\n|900002|No Appeasement found with given appeasement id|\n|900004|An internal error occured.|\n" } }, "parameters":[ { "in":"path", "name":"id", "description":"ID corresponding to the appeasement to be fetched.", "type":"string", "required":true } ], "tags":[ "Agent/Appeasement" ], "x-internal-id":"ccagent-v1-appeasements-{id}-get", "x-filename-id":"ccagent-v1-appeasements-id-get" }, "delete":{ "summary":"deleteAppeasement", "produces":[ "application/json" ], "operationId":"deleteAppeasement", "description":"Delete an incomplete appeasement", "responses":{ "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|900002|No Appeasement found with given appeasement id|\n|900007|An error occured while deleting the appeasement.|\n|900002|No Appeasement found with given appeasement id|\n|900036|Appeasement appeasementId is not in INCOMPLETE state." }, "204":{ "description":"No content." } }, "parameters":[ { "in":"path", "name":"id", "description":"ID corresponding to the appeasement to be deleted.", "type":"string", "required":true } ], "tags":[ "Agent/Appeasement" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-appeasements-{id}-delete", "x-filename-id":"ccagent-v1-appeasements-id-delete" }, "put":{ "summary":"updateAppeasement", "produces":[ "application/json" ], "operationId":"updateAppeasement", "description":"Updates an Appeasement.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/updateAppeasement_response" }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|900000|When an internal error occurs|\n|13001|When the input is invalid|\n|900015|When an internal error occurs with the appeasementValidation webhook|\n|900016|When the appeasement is invalid according to the appeasementValidation webhook|\n|900017|When the invalid refundType is passed for an appeasement refund|\n|900001|If an internal error occurs with the repository|\n|900002|When the given appeasement Id is invalid or not found|\n|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|\n" } }, "parameters":[ { "in":"header", "name":"X-CCAsset-Language", "description":"The asset language of the request. E.g., en,de,fr_CA.", "type":"string", "required":false }, { "in":"path", "name":"id", "description":"ID corresponding to the appeasement to be updated.", "type":"string", "required":true }, { "in":"header", "name":"X-CCOrganization", "description":"The organization Id on which the appeasement is being updated. ", "type":"string", "required":false }, { "in":"header", "name":"X-CCSite", "description":"The site Id on which the appeasement is being updated.", "type":"string", "required":false }, { "schema":{ "$ref":"#/definitions/updateAppeasement_request" }, "in":"body", "name":"updateAppeasement_request" } ], "tags":[ "Agent/Appeasement" ], "consumes":[ "application/json" ], "x-internal-id":"ccagent-v1-appeasements-{id}-put", "x-filename-id":"ccagent-v1-appeasements-id-put" } }, "/ccagent/v1/mfalogin":{ "post":{ "summary":"mfalogin", "produces":[ "application/json" ], "operationId":"mfalogin", "description":"MFA Login. Perform login operation with multi-factor authentication.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/mfalogin_response" }, "examples":{ "application/json":{ "access_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MTQxNDk5NTYsInN1YiI6IjExMDU1OCIsImlzcyI6InN0b3JlZnJvbnRVSSIsImlhdCI6MTQxNDE0OTAyNn0=.B9qM0/VKpCNKvjCmOnUPv4RS7mkIDgKcP8RJPaVQGYU=", "token_type":"bearer", "expires_in":930 } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response" } }, "parameters":[ { "in":"formData", "name":"grant_type", "description":"Authorization parameter for grant type. Should be set to password", "type":"string", "required":true }, { "in":"formData", "name":"username", "description":"Authorization parameter for username.", "type":"string", "required":true }, { "in":"formData", "name":"password", "description":"Authorization parameter for password.", "type":"string", "required":true }, { "in":"formData", "name":"totp_code", "description":"Authorization parameter for passcode.", "type":"string", "required":true } ], "tags":[ "Agent/OAuth" ], "consumes":[ "application/x-www-form-urlencoded" ], "x-internal-id":"ccagent-v1-mfalogin-post", "x-filename-id":"ccagent-v1-mfalogin-post" } }, "/ccagent/v1/skus":{ "get":{ "summary":"listSkus", "produces":[ "application/json" ], "operationId":"listSkus", "description":"List Skus. Returns a paginated list of SKUs, including variant options, prices, and inventory. Optionally filtered by 'q' parameter. Takes X-CCAgentContext header which is a JSON object with 'shopperProfileId' as a property. If 'shopperProfileId' is not provided, it is considered as an anonymous profile.Additionally takes x-cssite header to return the skus pertaining to the site", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/listSkus_response" }, "examples":{ "application/json":{ "total":1, "totalResults":1, "offset":0, "limit":250, "links":[ { "rel":"self", "href":"http://localhost:9080/ccagentui/v1/skus?q=barcode%20eq%20%2212345%22" } ], "sort":[ { "property":"id", "order":"asc" } ], "items":[ { "dynamicPropertyMapLong":{ "sku-WomensApparel_color":13, "sku-WomensApparel_size":0 }, "bundleLinks":[ ], "largeImage":null, "smallImage":null, "derivedCatalogs":[ { "repositoryId":"cloudCatalog" } ], "endDate":null, "listPrices":{ "defaultPriceGroup":55 }, "configurationMetadata":[ ], "type":"sku-WomensApparel", "largeImageURLs":[ ], "derivedSalePriceFrom":"defaultPriceGroup", "variantOptions":[ [ { "optionValue":"Poppy", "optionName":"Color" }, { "optionValue":"Small", "optionName":"Size" } ] ], "translations":{ "1":{ "repositoryId":"xsku2535_1_en_US" }, "27":{ "repositoryId":"xsku2535_1_vi" } }, "id":"xsku2535_1", "barcode":"12345", "wholesalePrice":null, "salePriceEndDate":null, "images":[ ], "unitOfMeasure":null, "primaryMediumImageURL":null, "skuInfos":{ }, "thumbImageURLs":[ ], "creationDate":"2016-05-09T14:54:09.000Z", "version":4, "parentProducts":[ { "longDescription":"Wear this skirt anywhere with anything. Flat front allows shirts to be tucked in or overlaid nicely, side zipper and snap rivet detailing around the waist.", "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=100&width=100", "largeImage":null, "smallImage":null, "displayName":"A-Line Skirt", "orderLimit":null, "onlineOnly":false, "description":"The simple perfect A line", "primaryFullImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg", "largeImageURLs":[ "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=940&width=940", "/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=940&width=940" ], "primaryLargeImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=940&width=940", "addOnProducts":[ { "repositoryId":"cp10004", "configurationOptions":[ { "product":{ "displayName":"OM-D E-M10 Digital Compact System Camera", "repositoryId":"camera_1", "id":"camera_1", "type":"camera" }, "repositoryId":"co10009", "id":"co10009", "sku":{ "repositoryId":"camerasku_1_1", "id":"camerasku_1_1" } }, { "product":{ "displayName":"OM-D E-M10 Digital Compact System Camera", "repositoryId":"camera_1", "id":"camera_1", "type":"camera" }, "repositoryId":"co10010", "id":"co10010", "sku":{ "repositoryId":"camerasku_1_2", "id":"camerasku_1_2" } } ], "id":"cp10004" }, { "repositoryId":"cp10005", "configurationOptions":[ { "product":{ "displayName":"Movie Gift Card", "repositoryId":"giftCard_1", "id":"giftCard_1", "type":"giftCard" }, "repositoryId":"co10011", "id":"co10011", "sku":{ "repositoryId":"giftCardsku_1", "id":"giftCardsku_1" } } ], "id":"cp10005" } ], "smallImageURLs":[ "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=300&width=300", "/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=300&width=300" ], "derivedShippingSurchargeFrom":"defaultPriceGroup", "derivedSalePriceFrom":"defaultPriceGroup", "id":"xprod2535", "childSKUs":[ { "repositoryId":"xsku2535_1" }, { "repositoryId":"xsku2535_2" }, { "repositoryId":"xsku2535_3" }, { "repositoryId":"xsku2535_4" }, { "repositoryId":"xsku2535_5" }, { "repositoryId":"xsku2535_6" } ], "primaryMediumImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=475&width=475", "salePrice":null, "fullImageURLs":[ "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg", "/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg" ], "active":true, "thumbImageURLs":[ "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=100&width=100", "/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=100&width=100" ], "productImages":[ { "repositoryId":"img_xprod2535_0" }, { "repositoryId":"img_xprod2535_1" } ], "route":"/product/xprod2535", "mediumImageURLs":[ "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=475&width=475", "/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=475&width=475" ], "repositoryId":"xprod2535", "derivedListPriceFrom":"defaultPriceGroup", "primarySourceImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=300&width=300", "shippingSurcharge":null, "primarySmallImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=300&width=300", "sourceImageURLs":[ "/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=300&width=300", "/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=300&width=300" ], "minOrderLimit":1, "avgCustRating":null, "listPrice":null } ], "size":"Small", "manufacturer_part_number":null, "catalogs":[ ], "mediumImageURLs":[ ], "primarySourceImageURL":null, "primarySmallImageURL":null, "sourceImageURLs":[ ], "startDate":null, "template":null, "primaryThumbImageURL":null, "replacementProducts":null, "dynamicAttributes":{ }, "fixedReplacementProducts":[ ], "color":"Poppy", "nonreturnable":false, "displayName":"A-Line Skirt", "description":null, "primaryFullImageURL":null, "salePrices":{ "defaultPriceGroup":null }, "productListingSku":null, "primaryLargeImageURL":null, "derivedOnlineOnly":false, "smallImageURLs":[ ], "derivedShippingSurchargeFrom":"defaultPriceGroup", "itemAcl":null, "shippingSurcharges":{ "defaultPriceGroup":null }, "onSale":false, "unit_of_measure":null, "dynamicPropertyMapString":{ }, "siteIds":[ ], "computedCatalogs":[ ], "discountable":true, "thumbnailImage":null, "catalogsReplacementProducts":[ ], "salePriceStartDate":null, "quantity":100, "salePrice":null, "fullImageURLs":[ ], "variantValuesOrder":{ }, "soldAsPackage":false, "auxiliaryMedia":{ }, "derivedListPriceFrom":"defaultPriceGroup", "repositoryId":"xsku2535_1", "shippingSurcharge":null, "fractionalQuantitiesAllowed":false, "fulfiller":null, "partNumber":null, "dynamicPropertyMapDouble":{ }, "configurable":false, "listPrice":55 } ] } }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|200020|Invalid query in 'q' parameter.|\n|30015|SiteId passed in x-ccsite header is currently inactive|\n|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|\n|50001|Internal Error.|\n|26050|Variants Internal Error.|\n" } }, "parameters":[ { "in":"query", "name":"q", "description":"Contains SCIM query language", "type":"string", "required":false }, { "in":"query", "name":"preFilter", "description":"Enabling this flag would improve response time by applying filter. However for better performance results, include only required properties in filterKey, fields , incldude query parameter and avoid including fields like parentProducts which intern have huge number of fields. While using this property ensure that repositoryId,id,parentProducts.id are always included in the response.", "type":"boolean", "required":false }, { "in":"query", "name":"catalogId", "description":"Catalog Id", "type":"string", "required":false }, { "in":"query", "name":"skuIds", "description":"Comma separated multiple SKU IDS", "type":"string", "required":false }, { "in":"query", "name":"storePriceListGroupId", "description":"Store PriceList Group id", "type":"string", "required":false }, { "in":"header", "name":"x-ccsite", "description":"the site id on which the orders is laced", "type":"string", "required":false } ], "tags":[ "Agent/Sku" ], "x-internal-id":"ccagent-v1-skus-get", "x-filename-id":"ccagent-v1-skus-get" } }, "/ccagent/v1/merchant/orderStates":{ "get":{ "summary":"getOrderStates", "produces":[ "application/json" ], "operationId":"getOrderStates", "description":"Get Order States. Lists the order States that can be used for searching for orders. Order state values incorporate changes made from admin UI, if any.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getOrderStates_response" }, "examples":{ "application/json":[ { "displayKey":"PROCESSING", "displayName":"Being processed" }, { "displayKey":"NO_PENDING_ACTION", "displayName":"Fulfilled" }, { "displayKey":"INCOMPLETE", "displayName":"Incomplete" }, { "displayKey":"PENDING_REMOVE", "displayName":"Pending removal" }, { "displayKey":"REMOVED", "displayName":"Removed" }, { "displayKey":"SUBMITTED", "displayName":"Submitted to fulfillment" } ] }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response" } }, "tags":[ "Agent/Merchant Settings" ], "x-internal-id":"ccagent-v1-merchant-orderStates-get", "x-filename-id":"ccagent-v1-merchant-orderstates-get" } }, "/ccagent/v1/appeasementTypes/{id}":{ "get":{ "summary":"getType", "produces":[ "application/json" ], "operationId":"getType", "description":"Gets an appeasement type based on the ID provided.", "responses":{ "200":{ "schema":{ "$ref":"#/definitions/getType_response" }, "description":"Following model is returned when operation succeeds." }, "default":{ "schema":{ "$ref":"#/definitions/errorModel" }, "description":"The error response.\n The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:\n\n\n|Error Code|Description|\n|------------------|------------------|\n|900000|An internal error occurred.|\n|900023|No appeasement type found with given appeasement id|\n" } }, "parameters":[ { "in":"path", "name":"id", "description":"ID corresponding to the appeasement type to be fetched.", "type":"string", "required":true } ], "tags":[ "Agent/AppeasementTypes" ], "x-internal-id":"ccagent-v1-appeasementTypes-{id}-get", "x-filename-id":"ccagent-v1-appeasementtypes-id-get" } }, "/ccagent/v1/itemTypes/{id}":{ "get":{ "summary":"getItemType", "produces":[ "application/json" ], "operationId":"getItemType", "description":"Get Item Type. Get item type and base type info. Below are the supported item types: