Jump to

• Request
• Response

terminateService

post

/ccstore/v1/services/{id}/terminate

Renew a service associated with a user.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  ID of an asset.

Header Parameters

• X-CCAsset-Language(optional): string
  The asset language of the request

Body ()

Root Schema : action_request

Type: object

Show Source

• transactionDate(optional): string
  The date and time on which the service request was made.

{
    "properties":{
        "transactionDate":{
            "description":"The date and time on which the service request was made.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : action_response

Type: object

Show Source

• configuratorItem(optional): object configuratorItem
  The configured item

{
    "properties":{
        "configuratorItem":{
            "description":"The configured item",
            "type":"object",
            "properties":{
                "serviceAccountId":{
                    "description":"The id of the service account.",
                    "type":"string"
                },
                "deactivationDate":{
                    "description":"Date on which the service contract ends.",
                    "type":"string"
                },
                "amount":{
                    "description":"The total amount of this item and sub items.",
                    "type":"string"
                },
                "quantity":{
                    "description":"The items quantity.",
                    "type":"integer"
                },
                "externalRecurringCharge":{
                    "description":"The items recurring charge.",
                    "type":"string"
                },
                "billingProfileId":{
                    "description":"The billing profile ID associated to the current item.",
                    "type":"string"
                },
                "externalData":{
                    "description":"Information about the configured item.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "values":{
                                "description":"The externalData values.",
                                "type":"object",
                                "properties":{
                                    "displayValue":{
                                        "description":"externalData vaulue value.",
                                        "type":"string"
                                    },
                                    "name":{
                                        "description":"externalData vaulue description.",
                                        "type":"string"
                                    },
                                    "label":{
                                        "description":"externalData vaulue label.",
                                        "type":"string"
                                    }
                                }
                            },
                            "name":{
                                "description":"Name of the externalData item.",
                                "type":"string"
                            }
                        }
                    }
                },
                "billingAccountId":{
                    "description":"The id of the billing account.",
                    "type":"string"
                },
                "externalRecurringChargeFrequency":{
                    "description":"The frequency of the recurring charges, E.g Per Month.",
                    "type":"string"
                },
                "childItems":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/action_response"
                    }
                },
                "transactionDate":{
                    "description":"ISO formatted Date on which the service action should be triggered.",
                    "type":"string"
                },
                "catalogRefId":{
                    "description":"The item sku id.",
                    "type":"string"
                },
                "configuratorId":{
                    "description":"The configuration session identifier.",
                    "type":"string"
                },
                "externalRecurringDuration":{
                    "description":"The duration of the recurring charges, E.g 1 Year.",
                    "type":"string"
                },
                "externalPrice":{
                    "description":"The price of this item.",
                    "type":"string"
                },
                "customerAccountId":{
                    "description":"The id of the customer account.",
                    "type":"string"
                },
                "assetId":{
                    "description":"The id of the account asset.",
                    "type":"string"
                },
                "actionCode":{
                    "description":"The configuration session identifier.",
                    "type":"string"
                },
                "serviceId":{
                    "description":"An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.",
                    "type":"string"
                },
                "activationDate":{
                    "description":"Date on which the service contract starts.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : configuratorItem

Type: object

The configured item

Show Source

• actionCode(optional): string
  The configuration session identifier.
• activationDate(optional): string
  Date on which the service contract starts.
• amount(optional): string
  The total amount of this item and sub items.
• assetId(optional): string
  The id of the account asset.
• billingAccountId(optional): string
  The id of the billing account.
• billingProfileId(optional): string
  The billing profile ID associated to the current item.
• catalogRefId(optional): string
  The item sku id.
• childItems(optional): array childItems
• configuratorId(optional): string
  The configuration session identifier.
• customerAccountId(optional): string
  The id of the customer account.
• deactivationDate(optional): string
  Date on which the service contract ends.
• externalData(optional): array externalData
  Information about the configured item.
• externalPrice(optional): string
  The price of this item.
• externalRecurringCharge(optional): string
  The items recurring charge.
• externalRecurringChargeFrequency(optional): string
  The frequency of the recurring charges, E.g Per Month.
• externalRecurringDuration(optional): string
  The duration of the recurring charges, E.g 1 Year.
• quantity(optional): integer
  The items quantity.
• serviceAccountId(optional): string
  The id of the service account.
• serviceId(optional): string
  An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.
• transactionDate(optional): string
  ISO formatted Date on which the service action should be triggered.

{
    "description":"The configured item",
    "type":"object",
    "properties":{
        "serviceAccountId":{
            "description":"The id of the service account.",
            "type":"string"
        },
        "deactivationDate":{
            "description":"Date on which the service contract ends.",
            "type":"string"
        },
        "amount":{
            "description":"The total amount of this item and sub items.",
            "type":"string"
        },
        "quantity":{
            "description":"The items quantity.",
            "type":"integer"
        },
        "externalRecurringCharge":{
            "description":"The items recurring charge.",
            "type":"string"
        },
        "billingProfileId":{
            "description":"The billing profile ID associated to the current item.",
            "type":"string"
        },
        "externalData":{
            "description":"Information about the configured item.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "values":{
                        "description":"The externalData values.",
                        "type":"object",
                        "properties":{
                            "displayValue":{
                                "description":"externalData vaulue value.",
                                "type":"string"
                            },
                            "name":{
                                "description":"externalData vaulue description.",
                                "type":"string"
                            },
                            "label":{
                                "description":"externalData vaulue label.",
                                "type":"string"
                            }
                        }
                    },
                    "name":{
                        "description":"Name of the externalData item.",
                        "type":"string"
                    }
                }
            }
        },
        "billingAccountId":{
            "description":"The id of the billing account.",
            "type":"string"
        },
        "externalRecurringChargeFrequency":{
            "description":"The frequency of the recurring charges, E.g Per Month.",
            "type":"string"
        },
        "childItems":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/action_response"
            }
        },
        "transactionDate":{
            "description":"ISO formatted Date on which the service action should be triggered.",
            "type":"string"
        },
        "catalogRefId":{
            "description":"The item sku id.",
            "type":"string"
        },
        "configuratorId":{
            "description":"The configuration session identifier.",
            "type":"string"
        },
        "externalRecurringDuration":{
            "description":"The duration of the recurring charges, E.g 1 Year.",
            "type":"string"
        },
        "externalPrice":{
            "description":"The price of this item.",
            "type":"string"
        },
        "customerAccountId":{
            "description":"The id of the customer account.",
            "type":"string"
        },
        "assetId":{
            "description":"The id of the account asset.",
            "type":"string"
        },
        "actionCode":{
            "description":"The configuration session identifier.",
            "type":"string"
        },
        "serviceId":{
            "description":"An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.",
            "type":"string"
        },
        "activationDate":{
            "description":"Date on which the service contract starts.",
            "type":"string"
        }
    }
}

Nested Schema : childItems

Type: array

Show Source

• Array of: object action_response

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/action_response"
    }
}

Nested Schema : externalData

Type: array

Information about the configured item.

Show Source

• Array of: object items

{
    "description":"Information about the configured item.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "values":{
                "description":"The externalData values.",
                "type":"object",
                "properties":{
                    "displayValue":{
                        "description":"externalData vaulue value.",
                        "type":"string"
                    },
                    "name":{
                        "description":"externalData vaulue description.",
                        "type":"string"
                    },
                    "label":{
                        "description":"externalData vaulue label.",
                        "type":"string"
                    }
                }
            },
            "name":{
                "description":"Name of the externalData item.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• name(optional): string
  Name of the externalData item.
• values(optional): object values
  The externalData values.

{
    "type":"object",
    "properties":{
        "values":{
            "description":"The externalData values.",
            "type":"object",
            "properties":{
                "displayValue":{
                    "description":"externalData vaulue value.",
                    "type":"string"
                },
                "name":{
                    "description":"externalData vaulue description.",
                    "type":"string"
                },
                "label":{
                    "description":"externalData vaulue label.",
                    "type":"string"
                }
            }
        },
        "name":{
            "description":"Name of the externalData item.",
            "type":"string"
        }
    }
}

Nested Schema : values

Type: object

The externalData values.

Show Source

• displayValue(optional): string
  externalData vaulue value.
• label(optional): string
  externalData vaulue label.
• name(optional): string
  externalData vaulue description.

{
    "description":"The externalData values.",
    "type":"object",
    "properties":{
        "displayValue":{
            "description":"externalData vaulue value.",
            "type":"string"
        },
        "name":{
            "description":"externalData vaulue description.",
            "type":"string"
        },
        "label":{
            "description":"externalData vaulue label.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "configuratorItem":{
        "serviceAccountId":"",
        "deactivationDate":"",
        "amount":"",
        "quantity":0,
        "externalRecurringCharge":"",
        "billingProfileId":"billingProfile-123",
        "externalData":[
            {
                "values":{
                    "displayValue":"",
                    "name":"",
                    "label":""
                },
                "name":""
            }
        ],
        "billingAccountId":"",
        "externalRecurringChargeFrequency":"",
        "childItems":[
            "#/configuratorItem"
        ],
        "transactionDate":"2018-06-27T12:59:59Z",
        "catalogRefId":"",
        "configuratorId":"",
        "externalRecurringChargeDuration":"",
        "externalPrice":"",
        "customerAccountId":"",
        "assetId":"",
        "actionCode":"",
        "serviceId":"",
        "activationDate":""
    }
}

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| |------------------|------------------| |551000|Could not get customers profile.| |551001|Customer has no service account.| |551002|Error retrieving customers service account.| |551003|Error retrieving account assets.| |551004|Error validating contact account ids in Order. |551005|Invalid account asset id. |551006|Account asset authorization error. |551007|Owner of the account asset could not be determined. |551008|Error submitting action request. |551009|Invalid transactionDate.

Body ()

Root Schema : errorModel

Type: object

Show Source

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

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

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

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

Nested Schema : items

Type: object

Show Source

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

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

Back to Top