Jump to

• Request
• Response

getReport

get

/ccagent/v1/agentReports/{id}

Get Report. Returns the data for displaying chart with order count and order value information with the id set as 'chartOrders'.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  Report Id.

Query Parameters

• endDate: string
  End date in ISO format for displaying the data
• priceGroupId: string
  PriceListGroup Id
• startDate: string
  Start date in ISO format for displaying the data

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getReport_response

Type: object

Show Source

• orderCountData(optional): array orderCountData
  Data for orders created on each day between the start date and end date
• orderValueData(optional): array orderValueData
  Data for value of orders created on each day between the start date and end date

{
    "properties":{
        "orderValueData":{
            "description":"Data for value of orders created on each day between the start date and end date",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "count":{
                        "description":"The total value of all the orders created on the day",
                        "type":"number"
                    },
                    "creationDate":{
                        "description":"Creation date of the order in ISO format.",
                        "type":"string"
                    }
                }
            }
        },
        "orderCountData":{
            "description":"Data for orders created on each day between the start date and end date",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "count":{
                        "description":"The number of orders created on the date",
                        "type":"integer"
                    },
                    "creationDate":{
                        "description":"Creation date of the order in ISO format.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : orderCountData

Type: array

Data for orders created on each day between the start date and end date

Show Source

• Array of: object items

{
    "description":"Data for orders created on each day between the start date and end date",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "count":{
                "description":"The number of orders created on the date",
                "type":"integer"
            },
            "creationDate":{
                "description":"Creation date of the order in ISO format.",
                "type":"string"
            }
        }
    }
}

Nested Schema : orderValueData

Type: array

Data for value of orders created on each day between the start date and end date

Show Source

• Array of: object items

{
    "description":"Data for value of orders created on each day between the start date and end date",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "count":{
                "description":"The total value of all the orders created on the day",
                "type":"number"
            },
            "creationDate":{
                "description":"Creation date of the order in ISO format.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• count(optional): integer
  The number of orders created on the date
• creationDate(optional): string
  Creation date of the order in ISO format.

{
    "type":"object",
    "properties":{
        "count":{
            "description":"The number of orders created on the date",
            "type":"integer"
        },
        "creationDate":{
            "description":"Creation date of the order in ISO format.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• count(optional): number
  The total value of all the orders created on the day
• creationDate(optional): string
  Creation date of the order in ISO format.

{
    "type":"object",
    "properties":{
        "count":{
            "description":"The total value of all the orders created on the day",
            "type":"number"
        },
        "creationDate":{
            "description":"Creation date of the order in ISO format.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "orderValueData":[
        {
            "count":0,
            "creationDate":"2015-04-26T18:30:00.000Z"
        },
        {
            "count":0,
            "creationDate":"2015-04-27T18:30:00.000Z"
        },
        {
            "count":7701.98,
            "creationDate":"2015-04-28T18:30:00.000Z"
        },
        {
            "count":0,
            "creationDate":"2015-04-29T18:30:00.000Z"
        },
        {
            "count":0,
            "creationDate":"2015-04-30T18:30:00.000Z"
        },
        {
            "count":0,
            "creationDate":"2015-05-01T18:30:00.000Z"
        },
        {
            "count":0,
            "creationDate":"2015-05-02T18:30:00.000Z"
        }
    ],
    "orderCountData":[
        {
            "count":0,
            "creationDate":"2015-04-26T18:30:00.000Z"
        },
        {
            "count":0,
            "creationDate":"2015-04-27T18:30:00.000Z"
        },
        {
            "count":8,
            "creationDate":"2015-04-28T18:30:00.000Z"
        },
        {
            "count":0,
            "creationDate":"2015-04-29T18:30:00.000Z"
        },
        {
            "count":0,
            "creationDate":"2015-04-30T18:30:00.000Z"
        },
        {
            "count":0,
            "creationDate":"2015-05-01T18:30:00.000Z"
        },
        {
            "count":0,
            "creationDate":"2015-05-02T18:30:00.000Z"
        }
    ],
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagent/v1/agentReports/chartOrders?startDate=2015-04-26T18%3A30%3A00.000Z&endDate=2015-05-03T18%3A30%3A00.000Z"
        }
    ]
}

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| |------------------|------------------| |50001|Generic Internal Error| |200125|Blank input parameters.|

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