action beezup_get_subscription_push_reporting {
label: "Get the push reporting related to this subscription"
provider: beezup
method: GET
path: "/v2/user/marketplaces/orders/subscriptions/{id}/reporting"
encoding: json
input: {
type: "object"
properties: {
id: {
type: "string"
format: "SubscriptionId"
}
pageNumber: {
type: "integer"
format: "PageNumber"
}
pageSize: {
type: "integer"
format: "PageSize"
}
}
required: ["id"]
additionalProperties: false
}
output: {
type: "array"
items: {
type: "object"
description: "The subscription push reporting"
required: ["subscriptionId", "eventId", "succeed", "lastOrderModificationUtcDate", "orderCount", "duration"]
properties: {
duration: {
type: "string"
format: "TimeSpan"
description: "The duration of the push operation"
}
errorMessage: {
type: "object"
required: ["errors"]
properties: {
errors: {
type: "array"
items: {
type: "object"
required: ["code", "message"]
properties: {
arguments: {
type: "object"
description: "a dictionary string/object"
}
code: {
type: "string"
description: "Error Code"
}
cultureName: {
type: "string"
description: "If the error is translated, the culture name will be indicated"
}
docUrl: {
type: "string"
format: "uri"
description: "The documentation related to this operation."
}
message: {
type: "string"
description: "The error message"
}
}
}
}
}
}
eventId: {
type: "string"
format: "MessageId"
description: "The message identifier. It's a guid."
}
httpStatus: {
type: "integer"
format: "int32"
description: "The HTTP status received from the consumer"
}
lastOrderModificationUtcDate: {
type: "string"
format: "date-time"
description: "This modification date correspond to the last order pushed by your subscription consumer"
}
maxRetryCount: {
type: "integer"
description: "The maximum BeezUP will retry to push orders. When we the retry count will reach maximum retry count, the subscription will be deactivated."
}
nextScheduledRetryUtcDate: {
type: "string"
format: "date-time"
description: "The next scheduled date we retry to send orders"
}
orderCount: {
type: "integer"
format: "int32"
description: "The order count sent"
}
requestUri: {
type: "string"
description: "The URL https://en.wikipedia.org/wiki/URL"
}
responseUri: {
type: "string"
description: "The URL https://en.wikipedia.org/wiki/URL"
}
retryCount: {
type: "integer"
description: "The retry count. When we the retry count will reach maximum retry count, the subscription will be deactivated."
}
subscriptionId: {
type: "string"
format: "guid"
description: "The identifier of the subscription to the orders for a merchant"
}
succeed: {
type: "boolean"
description: "Indicates if the push operation has succeed"
}
}
}
}
}