Jump to

• Request
• Response

Calculate Price

post

/ccstore/v1/cpq/prices/calculate

Calculates the prices for given Products from external systems.

Request

Supported Media Types

• application/json

Body ()

Root Schema : calculatePrice_request

Type: object

Show Source

• items(required): array items
• requiredResponseProperties: array requiredResponseProperties
  CPQ properties that are required in the response.

{
    "type":"object",
    "properties":{
        "requiredResponseProperties":{
            "description":"CPQ properties that are required in the response.",
            "type":"array",
            "items":{
                "description":"CPQ property",
                "type":"string"
            }
        },
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "quantity":{
                        "type":"number"
                    },
                    "catRefId":{
                        "type":"string"
                    }
                }
            },
            "required":[
                "catRefId",
                "quantity"
            ]
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "quantity":{
                "type":"number"
            },
            "catRefId":{
                "type":"string"
            }
        }
    },
    "required":[
        "catRefId",
        "quantity"
    ]
}

Nested Schema : requiredResponseProperties

Type: array

CPQ properties that are required in the response.

Show Source

• Array of: string
  CPQ property

{
    "description":"CPQ properties that are required in the response.",
    "type":"array",
    "items":{
        "description":"CPQ property",
        "type":"string"
    }
}

Nested Schema : items

Type: object

Show Source

• catRefId: string
• quantity: number

{
    "type":"object",
    "properties":{
        "quantity":{
            "type":"number"
        },
        "catRefId":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : calculatePrice_response

Type: object

Show Source

• items: array items
• lastPriced: string
  Requested Timestamp of when these items are priced.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "unitPrice":{
                        "description":"unit price of the item",
                        "type":"number"
                    },
                    "amount":{
                        "description":"Total Amount w.r.t to quantity.",
                        "type":"number"
                    },
                    "charges":{
                        "description":"List of various charges assigned to the item",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "unitPrice":{
                                    "description":"unit price of the item",
                                    "type":"number"
                                },
                                "amount":{
                                    "description":"Total Amount w.r.t to quantity.",
                                    "type":"number"
                                },
                                "isProductPrice":{
                                    "description":"This property tells which charge among others is Product price",
                                    "type":"boolean"
                                },
                                "name":{
                                    "description":"Name of the charge",
                                    "type":"string"
                                },
                                "chargeType":{
                                    "description":"Type of the charge",
                                    "type":"string"
                                },
                                "priceType":{
                                    "description":"Price type for this charge. i.e., one-time, recurring or usage",
                                    "type":"string"
                                },
                                "integrationId":{
                                    "description":"Integration id for this charge",
                                    "type":"string"
                                },
                                "chargeCode":{
                                    "description":"Charge code",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "quantity":{
                        "description":"quantity of this item",
                        "type":"number"
                    },
                    "catRefId":{
                        "description":"sku id or catalog ref id",
                        "type":"string"
                    }
                }
            }
        },
        "lastPriced":{
            "description":"Requested Timestamp of when these items are priced.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "unitPrice":{
                "description":"unit price of the item",
                "type":"number"
            },
            "amount":{
                "description":"Total Amount w.r.t to quantity.",
                "type":"number"
            },
            "charges":{
                "description":"List of various charges assigned to the item",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "unitPrice":{
                            "description":"unit price of the item",
                            "type":"number"
                        },
                        "amount":{
                            "description":"Total Amount w.r.t to quantity.",
                            "type":"number"
                        },
                        "isProductPrice":{
                            "description":"This property tells which charge among others is Product price",
                            "type":"boolean"
                        },
                        "name":{
                            "description":"Name of the charge",
                            "type":"string"
                        },
                        "chargeType":{
                            "description":"Type of the charge",
                            "type":"string"
                        },
                        "priceType":{
                            "description":"Price type for this charge. i.e., one-time, recurring or usage",
                            "type":"string"
                        },
                        "integrationId":{
                            "description":"Integration id for this charge",
                            "type":"string"
                        },
                        "chargeCode":{
                            "description":"Charge code",
                            "type":"string"
                        }
                    }
                }
            },
            "quantity":{
                "description":"quantity of this item",
                "type":"number"
            },
            "catRefId":{
                "description":"sku id or catalog ref id",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• amount: number
  Total Amount w.r.t to quantity.
• catRefId: string
  sku id or catalog ref id
• charges: array charges
  List of various charges assigned to the item
• quantity: number
  quantity of this item
• unitPrice: number
  unit price of the item

{
    "type":"object",
    "properties":{
        "unitPrice":{
            "description":"unit price of the item",
            "type":"number"
        },
        "amount":{
            "description":"Total Amount w.r.t to quantity.",
            "type":"number"
        },
        "charges":{
            "description":"List of various charges assigned to the item",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "unitPrice":{
                        "description":"unit price of the item",
                        "type":"number"
                    },
                    "amount":{
                        "description":"Total Amount w.r.t to quantity.",
                        "type":"number"
                    },
                    "isProductPrice":{
                        "description":"This property tells which charge among others is Product price",
                        "type":"boolean"
                    },
                    "name":{
                        "description":"Name of the charge",
                        "type":"string"
                    },
                    "chargeType":{
                        "description":"Type of the charge",
                        "type":"string"
                    },
                    "priceType":{
                        "description":"Price type for this charge. i.e., one-time, recurring or usage",
                        "type":"string"
                    },
                    "integrationId":{
                        "description":"Integration id for this charge",
                        "type":"string"
                    },
                    "chargeCode":{
                        "description":"Charge code",
                        "type":"string"
                    }
                }
            }
        },
        "quantity":{
            "description":"quantity of this item",
            "type":"number"
        },
        "catRefId":{
            "description":"sku id or catalog ref id",
            "type":"string"
        }
    }
}

Nested Schema : charges

Type: array

List of various charges assigned to the item

Show Source

• Array of: object items

{
    "description":"List of various charges assigned to the item",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "unitPrice":{
                "description":"unit price of the item",
                "type":"number"
            },
            "amount":{
                "description":"Total Amount w.r.t to quantity.",
                "type":"number"
            },
            "isProductPrice":{
                "description":"This property tells which charge among others is Product price",
                "type":"boolean"
            },
            "name":{
                "description":"Name of the charge",
                "type":"string"
            },
            "chargeType":{
                "description":"Type of the charge",
                "type":"string"
            },
            "priceType":{
                "description":"Price type for this charge. i.e., one-time, recurring or usage",
                "type":"string"
            },
            "integrationId":{
                "description":"Integration id for this charge",
                "type":"string"
            },
            "chargeCode":{
                "description":"Charge code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• amount: number
  Total Amount w.r.t to quantity.
• chargeCode: string
  Charge code
• chargeType: string
  Type of the charge
• integrationId: string
  Integration id for this charge
• isProductPrice: boolean
  This property tells which charge among others is Product price
• name: string
  Name of the charge
• priceType: string
  Price type for this charge. i.e., one-time, recurring or usage
• unitPrice: number
  unit price of the item

{
    "type":"object",
    "properties":{
        "unitPrice":{
            "description":"unit price of the item",
            "type":"number"
        },
        "amount":{
            "description":"Total Amount w.r.t to quantity.",
            "type":"number"
        },
        "isProductPrice":{
            "description":"This property tells which charge among others is Product price",
            "type":"boolean"
        },
        "name":{
            "description":"Name of the charge",
            "type":"string"
        },
        "chargeType":{
            "description":"Type of the charge",
            "type":"string"
        },
        "priceType":{
            "description":"Price type for this charge. i.e., one-time, recurring or usage",
            "type":"string"
        },
        "integrationId":{
            "description":"Integration id for this charge",
            "type":"string"
        },
        "chargeCode":{
            "description":"Charge code",
            "type":"string"
        }
    }
}

Example Response (application/json)

[
]

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

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

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

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

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

Nested Schema : items

Type: object

Show Source

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

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

Back to Top