Jump to

• Request
• Response
• Examples

Delete one price book and its contents

post

/fscmRestApi/resources/11.13.18.05/priceBooks/{PriceBookNumber}/action/deletePriceBook

Deletes one price book and its contents based on a set of parameters.

Request

Path Parameters

• PriceBookNumber(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• inputParams: object inputParams
  Additional Properties Allowed: additionalProperties

  Set of input parameters used to determine how a price book is deleted.

{
    "type":"object",
    "properties":{
        "inputParams":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Set of input parameters used to determine how a price book is deleted.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : inputParams

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Set of input parameters used to determine how a price book is deleted.",
    "nullable":true
}

Set of input parameters used to determine how a price book is deleted.

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  Information returned by the price book deletion process.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Information returned by the price book deletion process."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Information returned by the price book deletion process."
}

Information returned by the price book deletion process.

Back to Top

Examples

This example describes how to delete one price book and its contents.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/priceBooks/PriceBookNumber/action/deletePriceBook"

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "result" : {
    "Status" : "SUCCESS"
  }
}

Back to Top