getWebHookResourceMetadata
get
/ccadmin/v1/metadata-catalog/webhook/{id}
Get Web Hook Resource Metadata. Returns metadata catalog of a webhook resource. The response will be in hyper schema format. The **JSON hyper schema** being served is **deprecated**. Use Swagger.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the resource
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getWebHookResourceMetadata_response
Type:
Show Source
object-
$schema(optional):
string
location of schema for the given resource
-
definitions(optional):
object definitions
respective properties of the resource
-
description(optional):
string
description of the resource being retrieved
-
title(optional):
string
title of metadata resource
-
token(optional):
string
The auth token for the Endpoint
-
type(optional):
string
type of metadata resource
Nested Schema : definitions
Type:
objectrespective properties of the resource
Example Response (application/json)
{
"$schema":"rest-schemas/",
"description":"The details of order created on the Oracle Commerce Cloud. The order includes item and shipment details",
"title":"orders",
"type":"object",
"definitions":{
"orders":{
"links":[
{
"schema":"#/definitions/orders",
"method":"POST",
"rel":"self",
"href":"http://localhost:9080/ccadmin/v1/webhook/orders",
"title":"This operation posts the details of an order"
}
],
"properties":{
"taxPriceInfo":{
"description":"The tax pricing details for the order.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price was discounted.",
"type":"boolean"
},
"cityTax":{
"description":"The monetary amount of city tax.",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"countyTax":{
"description":"The monetary amount of county tax.",
"type":"number"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"districtTax":{
"description":"Tax amount for the district.",
"type":"number"
},
"stateTax":{
"description":"Tax amount for the state.",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code.",
"type":"string"
},
"countryTax":{
"description":"The monetary amount of country tax.",
"type":"number"
}
}
},
"shippingGroups":{
"description":"Shipping groups represent shipments and include commerceItemRelationships that represent which commerce items in what quantity are included in the shipment. Shipping groups in a request are matched to existing shipping groups by id, followed by description, followed by (for hardgoodShippingGroups) shippingMethod + address.",
"type":"array",
"items":{
"type":"object",
"properties":{
"shippingMethod":{
"description":"The shipping method.",
"type":"string"
},
"description":{
"description":"The description of this shipping group. Defaults to the ID.",
"type":"string"
},
"submittedDate":{
"format":"date-time",
"description":"The date the shipping group was submitted.",
"type":"string"
},
"priceInfo":{
"description":"The pricing details about this shipping group.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether this item is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"rawShipping":{
"description":"The monitary amount of the cost of raw shipping.",
"type":"number"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts.",
"type":"string"
}
}
},
"shipOnDate":{
"format":"date-time",
"description":"The date this shipping group is expected to ship upon.",
"type":"string"
},
"actualShipDate":{
"format":"date-time",
"description":"The actual shipped date of this shipping group.",
"type":"string"
},
"specialInstructions":{
"description":"Special instructions for the shipping group. Keys and values are strings.",
"type":"object",
"properties":{
"additionalProperties":{
"type":"string"
}
}
},
"shippingAddress":{
"description":"The shipping address for this shipping group.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address Line 3.",
"type":"string"
},
"address2":{
"description":"Address Line 2.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string"
},
"address1":{
"description":"Address Line 1.",
"type":"string"
},
"prefix":{
"description":"Prefix.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string"
},
"postalCode":{
"description":"Postal code.",
"type":"string"
},
"jobTitle":{
"description":"Job title.",
"type":"string"
},
"county":{
"description":"Name of the county.",
"type":"string"
},
"ownerId":{
"description":"The ID of the owner of this address.",
"type":"string"
},
"suffix":{
"description":"Suffix.",
"type":"string"
},
"firstName":{
"description":"First name.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string"
},
"faxNumber":{
"description":"The fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
},
"id":{
"description":"ID.",
"type":"string"
},
"email":{
"description":"The email address",
"type":"string"
}
}
},
"commerceItemRelationships":{
"description":"The commerce item relationships are instances of ShippingGroupCommerceItemRelationship that represent how many of which commerce items are included in the order. Please see caution in description of update order. Existing commerce items relationships are matched to input data by id, followed by commerceItemId, followed by commerceItemExternalId.",
"type":"array",
"items":{
"type":"object",
"properties":{
"commerceItemId":{
"description":"The referenced commerce item's internal ID.",
"type":"string"
},
"amount":{
"description":"The monetary value.",
"type":"number"
},
"quantity":{
"description":"The quantity of items referenced by this relationship.",
"type":"integer"
},
"relationshipType":{
"description":"The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.",
"type":"string"
},
"returnedQuantity":{
"description":"Number of referenced items that were returned.",
"type":"integer"
},
"commerceItemExternalId":{
"description":"The referenced commerce item's external ID.",
"type":"string"
},
"id":{
"description":"The native ID of this item.",
"type":"string"
}
}
}
},
"id":{
"description":"The ID of this shipping group.",
"type":"string"
},
"state":{
"description":"The state of this shipping group.",
"type":"string"
},
"stateDetail":{
"description":"Details about the state of this shipping group.",
"type":"string"
},
"trackingNumber":{
"description":"The tracking number. In case of multiple tracking numbers the format should be carrierId-trackingNumber,carrierId-trackingNumber..., Here carrierId is the Id which has been added through the addCarrier end point.",
"type":"string"
},
"handlingInstructions":{
"description":"Handling instructions. Currently read-only.",
"type":"array",
"items":{
"type":"string",
"properties":{
}
}
},
"shippingGroupClassType":{
"description":"The class type for the ShippingGroup. Currently must be \"hardgoodShippingGroup\".",
"type":"string"
}
}
}
},
"lastModifiedTime":{
"description":"The last modified time.",
"type":"integer"
},
"creationTime":{
"description":"The creation time.",
"type":"integer"
},
"profile":{
"description":"Basic profile information. (read-only)",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string"
},
"firstName":{
"description":"First name.",
"type":"string"
},
"shippingAddress":{
"description":"Default shipping address",
"type":"object",
"properties":{
"country":{
"description":"Country.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string"
},
"address3":{
"description":"Address Line 3.",
"type":"string"
},
"address2":{
"description":"Address Line 2.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string"
},
"address1":{
"description":"Address Line 1.",
"type":"string"
},
"postalCode":{
"description":"Postal code.",
"type":"string"
},
"county":{
"description":"Name of the county.",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
}
}
},
"middleName":{
"description":"Middle name.",
"type":"string"
},
"email":{
"description":"The email address",
"type":"string"
}
}
},
"shippingGroupCount":{
"description":"The number of shipping groups (read-only, value is ignored when updating).",
"type":"integer"
},
"paymentGroups":{
"description":"The array of payment groups represent the payment(s) that paid for the order. Orders when placed will have an instance of a CyberSource TokenizedCreditCard (paymentGroupClassType and paymentMethod of \"tokenizedCreditCard\"). The paymentGroups property can be updated to include instances of ExternalPaymentGroup (paymentGroupClassType and paymentMethod of \"externalPaymentGroup\"). ExternalPaymentGroups represent methods of payment that are external and opaque to cloud commerce, and which were taken after the order was initially placed.",
"type":"array",
"items":{
"type":"object",
"properties":{
"expirationYear":{
"description":"A string containing the two or four digit year when the credit card expires. (only only for TokenizedCreditCards)",
"type":"string"
},
"externalType":{
"description":"The type in the external system. Might be \"StoreCredit\", \"CreditCard\", \"Check\", etc. (only for ExternalPaymentGroups).",
"type":"string"
},
"amountAuthorized":{
"description":"The monetary amount authorized.",
"type":"number"
},
"amount":{
"description":"The monetary amount of the payment.",
"type":"number"
},
"externalId":{
"description":"The ID for the payment group in an external system (like the OMS)",
"type":"string"
},
"expirationMonth":{
"description":"A string containing the two digit month when the credit card expires. (only only for TokenizedCreditCards)",
"type":"string"
},
"creditCardType":{
"description":"The type of the credit card. (only for TokenizedCreditCards)",
"type":"string"
},
"submittedDate":{
"format":"date-time",
"description":"The date the payment was submitted.",
"type":"string"
},
"authorizationStatus":{
"description":"Aray of authorization status objects.",
"type":"array",
"items":{
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"transactionSuccess":{
"description":"Whether the transaction was successful.",
"type":"boolean"
},
"errorMessage":{
"description":"The error message, if any.",
"type":"string"
},
"transactionId":{
"description":"The transaction ID.",
"type":"string"
},
"transactionTimestamp":{
"description":"The timestamp of the transaction.",
"type":"string"
}
}
}
},
"token":{
"description":"The CyberSource token string. (only for tokenizedCreditCard)",
"type":"string"
},
"paymentGroupClassType":{
"description":"The class type of the payment group. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
"type":"string"
},
"creditCardNumber":{
"description":"The last four digits of the credit card number. (only for TokenizedCreditCards)",
"type":"string"
},
"externalSubtype":{
"description":"The subtype in the external system. Might be \"VISA\" for a PaymentGroup with an external type of \"CreditCard\". (only for ExternalPaymentGroups)",
"type":"string"
},
"paymentMethod":{
"description":"The payment method. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
"type":"string"
},
"externalSourceId":{
"description":"The external source ID, limited to 6 characters. (only for ExternalPaymentGroups)",
"type":"string"
},
"state":{
"description":"The state of this payment group.",
"type":"string"
},
"id":{
"description":"The internal ID of the payment group.",
"type":"string"
},
"stateDetail":{
"description":"Details about the state of this payment group.",
"type":"string"
},
"currencyCode":{
"description":"The three character currency code. For example: USD.",
"type":"string"
},
"expirationDayOfMonth":{
"description":"A string containing the two digit day of month when the credit card expires. (only only for TokenizedCreditCards)",
"type":"string"
}
}
}
},
"salesChannel":{
"description":"The sales channel of this order. default to \"default\".",
"type":"string"
},
"paymentGroupCount":{
"description":"The number of payment groups. (read-only, value is ignored when updating)",
"type":"integer"
},
"priceInfo":{
"description":"Pricing information, an instance of OrderPriceInfo.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"total":{
"description":"The monetary total: amount + shipping + tax. (read-only)",
"type":"number"
},
"shipping":{
"description":"The monetary cost of shipping.",
"type":"number"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"manualAdjustmentTotal":{
"description":"The monetary total of manual adjustments.",
"type":"number"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"rawSubtotal":{
"description":"The monetary raw subtotal.",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"profileId":{
"description":"The ID of the shopper profile that owns the order.",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the order was placed.",
"type":"string"
},
"totalCommerceItemCount":{
"description":"The total count of commerce items in the order. (read-only)",
"type":"integer"
},
"state":{
"description":"The state of the order.",
"type":"string"
},
"id":{
"description":"The ID",
"type":"string"
},
"commerceItems":{
"description":"The commerce items (sometimes referred to as \"line items\") represent which actual skus are included in thef order in what quantity, and related information. Please see caution in description of update order. Existing commerce items are matched to input data by externalId, followed by id, followed by catalogRefId. The elements in the commerceItem are instances of CommerceItemImpl.",
"type":"array",
"items":{
"type":"object",
"properties":{
"priceInfo":{
"description":"Details about pricing.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this order.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quanity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"catalogId":{
"description":"The ID of the catalog which this commerce item references.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"returnedQuantity":{
"description":"The quantity returned.",
"type":"integer"
},
"productDisplayName":{
"description":"The product's display name. (read-only, obtained from the referenced product)",
"type":"string"
},
"catalogKey":{
"description":"The key of the catalog this commerce item references.",
"type":"string"
},
"externalId":{
"description":"An optional, external ID for this commerce item.",
"type":"string"
},
"id":{
"description":"The internal/native ID for this commerce item.",
"type":"string"
},
"state":{
"description":"The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships)",
"type":"string"
},
"stateDetail":{
"description":"Details about the state of this commerce item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
}
}
}
}
}
}
}
}Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|13101|METADATA INTERNAL ERROR|
Root Schema : errorModel
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code