action beezup_get_order_list_full_v3 { label: "Get a paginated list of all Orders with all Order and Order Item(s) properties" description: "The purpose of this operation is to reduce the amount of request to the API.\\\n\\\nPrevious implmentation of this feature only returned a partial (light) version of the Orders. The purpose of this API is to reduce the number of incoming requests by returning the complete (full) Order and Order Item(s) properties.\n" provider: beezup method: POST path: "/orders/v3/list/full" encoding: json input: { type: "object" properties: { "Accept-Encoding": { type: "string" } } required: ["Accept-Encoding"] additionalProperties: false } output: { type: "object" required: ["links", "orders", "paginationResult"] properties: { links: { type: "object" } orders: { type: "array" items: { type: "object" } } paginationResult: { type: "object" required: ["entryCount", "links", "pageCount", "totalEntryCount"] properties: { entryCount: { type: "integer" description: "The entry count currently returned" } links: { type: "object" description: "The navigation links 'first', 'last', 'next', 'previous'" required: ["first", "last"] properties: { first: { type: "object" required: ["href"] properties: { allOptionalParamsProvided: { type: "boolean" description: "indicates whether all optionals params have been provided" } allRequiredParamsProvided: { type: "boolean" description: "indicates whether all required params have been provided" } description: { type: "string" description: "The description of the link" } docUrl: { type: "string" format: "uri" description: "The documentation related to this operation." } href: { type: "string" description: "Indicate the relative uri for this link" } info: { type: "object" properties: { errors: { type: "array" items: { type: "object" properties: { errorArguments: { type: "object" } errorCode: { type: "string" } errorGuid: { type: "string" format: "uuid" } errorMessage: { type: "string" } exceptionDetail: { type: "object" properties: { helpLink: { type: "string" } message: { type: "string" } stackTrace: { type: "string" } type: { type: "string" } } } objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } source: { type: "string" } technicalErrorMessage: { type: "string" } utcDate: { type: "string" format: "date-time" } } } } informations: { type: "array" items: { type: "object" properties: { informationArguments: { type: "object" } informationCode: { type: "string" } informationMessage: { type: "string" } objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } } } } successes: { type: "array" items: { type: "object" properties: { objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } successArguments: { type: "object" } successCode: { type: "string" } successMessage: { type: "string" } } } } warnings: { type: "array" items: { type: "object" properties: { technicalErrorMessage: { type: "string" } warningArguments: { type: "object" } warningCode: { type: "string" } warningMessage: { type: "string" } } } } } } label: { type: "string" description: "The label corresponding to the link. This label is automatically translated based on the Accept-Language http header." } method: { type: "string" description: "Indicate the http method to use on this link" enum: ["GET", "POST", "PATCH", "DELETE", "PUT", "HEAD"] } operationId: { type: "string" description: "The operationId to call." } parameters: { type: "object" } rel: { type: "string" description: "Indicate the relation name related to the link" } urlTemplated: { type: "boolean" description: "indicates whether the href is templated or not" } } } last: { type: "object" required: ["href"] properties: { allOptionalParamsProvided: { type: "boolean" description: "indicates whether all optionals params have been provided" } allRequiredParamsProvided: { type: "boolean" description: "indicates whether all required params have been provided" } description: { type: "string" description: "The description of the link" } docUrl: { type: "string" format: "uri" description: "The documentation related to this operation." } href: { type: "string" description: "Indicate the relative uri for this link" } info: { type: "object" properties: { errors: { type: "array" items: { type: "object" properties: { errorArguments: { type: "object" } errorCode: { type: "string" } errorGuid: { type: "string" format: "uuid" } errorMessage: { type: "string" } exceptionDetail: { type: "object" properties: { helpLink: { type: "string" } message: { type: "string" } stackTrace: { type: "string" } type: { type: "string" } } } objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } source: { type: "string" } technicalErrorMessage: { type: "string" } utcDate: { type: "string" format: "date-time" } } } } informations: { type: "array" items: { type: "object" properties: { informationArguments: { type: "object" } informationCode: { type: "string" } informationMessage: { type: "string" } objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } } } } successes: { type: "array" items: { type: "object" properties: { objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } successArguments: { type: "object" } successCode: { type: "string" } successMessage: { type: "string" } } } } warnings: { type: "array" items: { type: "object" properties: { technicalErrorMessage: { type: "string" } warningArguments: { type: "object" } warningCode: { type: "string" } warningMessage: { type: "string" } } } } } } label: { type: "string" description: "The label corresponding to the link. This label is automatically translated based on the Accept-Language http header." } method: { type: "string" description: "Indicate the http method to use on this link" enum: ["GET", "POST", "PATCH", "DELETE", "PUT", "HEAD"] } operationId: { type: "string" description: "The operationId to call." } parameters: { type: "object" } rel: { type: "string" description: "Indicate the relation name related to the link" } urlTemplated: { type: "boolean" description: "indicates whether the href is templated or not" } } } next: { type: "object" required: ["href"] properties: { allOptionalParamsProvided: { type: "boolean" description: "indicates whether all optionals params have been provided" } allRequiredParamsProvided: { type: "boolean" description: "indicates whether all required params have been provided" } description: { type: "string" description: "The description of the link" } docUrl: { type: "string" format: "uri" description: "The documentation related to this operation." } href: { type: "string" description: "Indicate the relative uri for this link" } info: { type: "object" properties: { errors: { type: "array" items: { type: "object" properties: { errorArguments: { type: "object" } errorCode: { type: "string" } errorGuid: { type: "string" format: "uuid" } errorMessage: { type: "string" } exceptionDetail: { type: "object" properties: { helpLink: { type: "string" } message: { type: "string" } stackTrace: { type: "string" } type: { type: "string" } } } objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } source: { type: "string" } technicalErrorMessage: { type: "string" } utcDate: { type: "string" format: "date-time" } } } } informations: { type: "array" items: { type: "object" properties: { informationArguments: { type: "object" } informationCode: { type: "string" } informationMessage: { type: "string" } objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } } } } successes: { type: "array" items: { type: "object" properties: { objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } successArguments: { type: "object" } successCode: { type: "string" } successMessage: { type: "string" } } } } warnings: { type: "array" items: { type: "object" properties: { technicalErrorMessage: { type: "string" } warningArguments: { type: "object" } warningCode: { type: "string" } warningMessage: { type: "string" } } } } } } label: { type: "string" description: "The label corresponding to the link. This label is automatically translated based on the Accept-Language http header." } method: { type: "string" description: "Indicate the http method to use on this link" enum: ["GET", "POST", "PATCH", "DELETE", "PUT", "HEAD"] } operationId: { type: "string" description: "The operationId to call." } parameters: { type: "object" } rel: { type: "string" description: "Indicate the relation name related to the link" } urlTemplated: { type: "boolean" description: "indicates whether the href is templated or not" } } } previous: { type: "object" required: ["href"] properties: { allOptionalParamsProvided: { type: "boolean" description: "indicates whether all optionals params have been provided" } allRequiredParamsProvided: { type: "boolean" description: "indicates whether all required params have been provided" } description: { type: "string" description: "The description of the link" } docUrl: { type: "string" format: "uri" description: "The documentation related to this operation." } href: { type: "string" description: "Indicate the relative uri for this link" } info: { type: "object" properties: { errors: { type: "array" items: { type: "object" properties: { errorArguments: { type: "object" } errorCode: { type: "string" } errorGuid: { type: "string" format: "uuid" } errorMessage: { type: "string" } exceptionDetail: { type: "object" properties: { helpLink: { type: "string" } message: { type: "string" } stackTrace: { type: "string" } type: { type: "string" } } } objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } source: { type: "string" } technicalErrorMessage: { type: "string" } utcDate: { type: "string" format: "date-time" } } } } informations: { type: "array" items: { type: "object" properties: { informationArguments: { type: "object" } informationCode: { type: "string" } informationMessage: { type: "string" } objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } } } } successes: { type: "array" items: { type: "object" properties: { objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } successArguments: { type: "object" } successCode: { type: "string" } successMessage: { type: "string" } } } } warnings: { type: "array" items: { type: "object" properties: { technicalErrorMessage: { type: "string" } warningArguments: { type: "object" } warningCode: { type: "string" } warningMessage: { type: "string" } } } } } } label: { type: "string" description: "The label corresponding to the link. This label is automatically translated based on the Accept-Language http header." } method: { type: "string" description: "Indicate the http method to use on this link" enum: ["GET", "POST", "PATCH", "DELETE", "PUT", "HEAD"] } operationId: { type: "string" description: "The operationId to call." } parameters: { type: "object" } rel: { type: "string" description: "Indicate the relation name related to the link" } urlTemplated: { type: "boolean" description: "indicates whether the href is templated or not" } } } } } pageCount: { type: "integer" description: "The page count" } totalEntryCount: { type: "integer" description: "The total entry count" } } } } } }