Feed API — client.sell.feed¶
Version v1.3.1 · base path /sell/feed/v1 · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
get_order_tasks ¶
get_order_tasks(*, date_range: str | None = None, feed_type: str | None = None, limit: int | str | None = None, look_back_days: str | None = None, offset: int | str | None = None, schedule_id: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_feed_models.OrderTaskCollection
get_order_tasks(*, date_range: str | None = None, feed_type: str | None = None, limit: int | str | None = None, look_back_days: str | None = None, offset: int | str | None = None, schedule_id: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_order_tasks(*, date_range: str | None = None, feed_type: str | None = None, limit: int | str | None = None, look_back_days: str | None = None, offset: int | str | None = None, schedule_id: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_feed_models.OrderTaskCollection | httpx.Response
This method returns the details and status for an array of order tasks. Rather than using a request payload, it does this through specified input in query parameters, such as feed_type or schedule_id . Specifying both feed_type and schedule_id results in an error. Since schedules are based on feed types, you can specify a schedule ( schedule_id ) that returns the needed feed_type .
create_order_task ¶
create_order_task(*, body: CreateOrderTaskRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
create_order_task(*, body: CreateOrderTaskRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_order_task(*, body: CreateOrderTaskRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
This method creates an order download task with filter criteria for the order report. When using this method, specify the feedType , schemaVersion , and filterCriteria for the report. The method returns the location response header containing the getOrderTask call URI to retrieve the order task you just created.
get_order_task ¶
get_order_task(task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_feed_models.OrderTask
get_order_task(task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_order_task(task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_feed_models.OrderTask | httpx.Response
This method retrieves the task details and status of the specified task. The input is task_id . For details about how this method is used, see Working with Order Feeds in the Selling Integration Guide.
get_inventory_tasks ¶
get_inventory_tasks(*, feed_type: str | None = None, schedule_id: str | None = None, look_back_days: str | None = None, date_range: str | None = None, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_feed_models.InventoryTaskCollection
get_inventory_tasks(*, feed_type: str | None = None, schedule_id: str | None = None, look_back_days: str | None = None, date_range: str | None = None, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_inventory_tasks(*, feed_type: str | None = None, schedule_id: str | None = None, look_back_days: str | None = None, date_range: str | None = None, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_feed_models.InventoryTaskCollection | httpx.Response
This method searches for multiple tasks of a specific feed type and includes date filters and pagination.
create_inventory_task ¶
create_inventory_task(*, body: CreateInventoryTaskRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
create_inventory_task(*, body: CreateInventoryTaskRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_inventory_task(*, body: CreateInventoryTaskRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
This method creates an inventory-related download task for a specified feed type with optional filter criteria. When using this method, specify the feedType . This method returns the location response header containing the getInventoryTask call URI to retrieve the inventory task you just created. The URL includes the eBay-assigned task ID, which you can use to reference the inventory task.
get_inventory_task ¶
get_inventory_task(task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_feed_models.InventoryTask
get_inventory_task(task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_inventory_task(task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_feed_models.InventoryTask | httpx.Response
This method retrieves the task details and status of the specified inventory-related task. The input is task_id .
get_schedules ¶
get_schedules(*, feed_type: str, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_feed_models.UserScheduleCollection
get_schedules(*, feed_type: str, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_schedules(*, feed_type: str, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_feed_models.UserScheduleCollection | httpx.Response
This method retrieves an array containing the details and status of all schedules based on the specified feed_type . Use this method to find a schedule if you do not know the schedule_id .
create_schedule ¶
create_schedule(*, body: CreateUserScheduleRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> dict[str, Any]
create_schedule(*, body: CreateUserScheduleRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_schedule(*, body: CreateUserScheduleRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> dict[str, Any] | httpx.Response
This method creates a schedule, which is a subscription to the specified schedule template. A schedule periodically generates a report for the feedType specified by the template. Specify the same feedType as the feedType of the associated schedule template. When creating the schedule, if available from the template, you can specify a preferred trigger hour, day of the week, or day of the month.
get_schedule ¶
get_schedule(schedule_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_feed_models.UserScheduleResponse
get_schedule(schedule_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_schedule(schedule_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_feed_models.UserScheduleResponse | httpx.Response
This method retrieves schedule details and status of the specified schedule. Specify the schedule to retrieve using the schedule_id . Use the getSchedules method to find a schedule if you do not know the schedule_id .
update_schedule ¶
update_schedule(schedule_id: str, *, body: UpdateUserScheduleRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
update_schedule(schedule_id: str, *, body: UpdateUserScheduleRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_schedule(schedule_id: str, *, body: UpdateUserScheduleRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
This method updates an existing schedule. Specify the schedule to update using the schedule_id path parameter. If the schedule template has changed after the schedule was created or updated, the input will be validated using the changed template. Note: Make sure to include all fields required by the schedule template ( scheduleTemplateId ).
delete_schedule ¶
delete_schedule(schedule_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
delete_schedule(schedule_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
delete_schedule(schedule_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
This method deletes an existing schedule. Specify the schedule to delete using the schedule_id path parameter.
get_latest_result_file ¶
get_latest_result_file(schedule_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> bytes
get_latest_result_file(schedule_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_latest_result_file(schedule_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> bytes | httpx.Response
This method downloads the latest Order Report generated by the schedule. The response of this call is a compressed or uncompressed CSV, XML, or JSON file, with the applicable file extension (for example: csv.gz). Specify the schedule_id path parameter to download its last generated file.
get_schedule_template ¶
get_schedule_template(schedule_template_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_feed_models.ScheduleTemplateResponse
get_schedule_template(schedule_template_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_schedule_template(schedule_template_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_feed_models.ScheduleTemplateResponse | httpx.Response
This method retrieves the details of the specified template. Specify the template to retrieve using the schedule_template_id path parameter. Use the getScheduleTemplates method to find a schedule template if you do not know the schedule_template_id .
get_schedule_templates ¶
get_schedule_templates(*, feed_type: str, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_feed_models.ScheduleTemplateCollection
get_schedule_templates(*, feed_type: str, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_schedule_templates(*, feed_type: str, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_feed_models.ScheduleTemplateCollection | httpx.Response
This method retrieves an array containing the details and status of all schedule templates based on the specified feed_type . Use this method to find a schedule template if you do not know the schedule_template_id .
get_tasks ¶
get_tasks(*, date_range: str | None = None, feed_type: str | None = None, limit: int | str | None = None, look_back_days: str | None = None, offset: int | str | None = None, schedule_id: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_feed_models.TaskCollection
get_tasks(*, date_range: str | None = None, feed_type: str | None = None, limit: int | str | None = None, look_back_days: str | None = None, offset: int | str | None = None, schedule_id: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_tasks(*, date_range: str | None = None, feed_type: str | None = None, limit: int | str | None = None, look_back_days: str | None = None, offset: int | str | None = None, schedule_id: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_feed_models.TaskCollection | httpx.Response
This method returns the details and status for an array of tasks based on a specified feed_type or schedule_id . Specifying both feed_type and schedule_id results in an error. Since schedules are based on feed types, you can specify a schedule ( schedule_id ) that returns the needed feed_type .
create_task ¶
create_task(*, body: CreateTaskRequest, x_ebay_c_marketplace_id: str | None = None, accept_language: str | None = None, raw_response: Literal[False] = False) -> None
create_task(*, body: CreateTaskRequest, x_ebay_c_marketplace_id: str | None = None, accept_language: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_task(*, body: CreateTaskRequest, x_ebay_c_marketplace_id: str | None = None, accept_language: str | None = None, raw_response: bool = False) -> None | httpx.Response
This method creates an upload task or a download task without filter criteria. When using this method, specify the feedType and the feed file schemaVersion . The feed type specified sets the task as a download or an upload task. For details about the upload and download flows, see Working with Order Feeds in the Selling Integration Guide. Note: The scope depends on the feed type.
get_input_file ¶
get_input_file(task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> bytes
get_input_file(task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_input_file(task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> bytes | httpx.Response
This method downloads a file previously uploaded using uploadFile . Specify the task_id from the uploadFile call. Note: With respect to LMS, this method applies to all feed types except LMS_ORDER_REPORT and LMS_ACTIVE_INVENTORY_REPORT . See LMS API Feeds in the Selling Integration Guide.
get_result_file ¶
get_result_file(task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> bytes
get_result_file(task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_result_file(task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> bytes | httpx.Response
This method retrieves the generated file that is associated with the specified task ID. The response of this call is a compressed or uncompressed CSV, XML, or JSON file, with the applicable file extension (for example: csv.gz). For details about how this method is used, see Working with Order Feeds in the Selling Integration Guide.
get_task ¶
get_task(task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_feed_models.Task
get_task(task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_task(task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_feed_models.Task | httpx.Response
This method retrieves the details and status of the specified task. The input is task_id . For details of how this method is used, see Working with Order Feeds in the Selling Integration Guide.
upload_file ¶
upload_file(task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> dict[str, Any]
upload_file(task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
upload_file(task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> dict[str, Any] | httpx.Response
This method associates the specified file with the specified task ID and uploads the input file. After the file has been uploaded, the processing of the file begins. Reports often take time to generate and it's common for this method to return an HTTP status of 202, which indicates the report is being generated. Use the getTask with the task ID or getTasks to determine the status of a report.
get_customer_service_metric_tasks ¶
get_customer_service_metric_tasks(*, date_range: str | None = None, feed_type: str | None = None, limit: int | str | None = None, look_back_days: str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_feed_models.CustomerServiceMetricTaskCollection
get_customer_service_metric_tasks(*, date_range: str | None = None, feed_type: str | None = None, limit: int | str | None = None, look_back_days: str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_customer_service_metric_tasks(*, date_range: str | None = None, feed_type: str | None = None, limit: int | str | None = None, look_back_days: str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_feed_models.CustomerServiceMetricTaskCollection | httpx.Response
Use this method to return an array of customer service metric tasks. You can limit the tasks returned by specifying a date range. Note: You can pass in either the look_back_days or date_range , but not both.
create_customer_service_metric_task ¶
create_customer_service_metric_task(*, body: CreateServiceMetricsTaskRequest, accept_language: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
create_customer_service_metric_task(*, body: CreateServiceMetricsTaskRequest, accept_language: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_customer_service_metric_task(*, body: CreateServiceMetricsTaskRequest, accept_language: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
Use this method to create a customer service metrics download task with filter criteria for the customer service metrics report. When using this method, specify the feedType and filterCriteria including both evaluationMarketplaceId and customerServiceMetricType for the report.
get_customer_service_metric_task ¶
get_customer_service_metric_task(task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_feed_models.ServiceMetricsTask
get_customer_service_metric_task(task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_customer_service_metric_task(task_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_feed_models.ServiceMetricsTask | httpx.Response
Use this method to retrieve customer service metric task details for the specified task. The input is task_id .
Models¶
ConfigurationsUsageEnum ¶
CreateTaskRequest ¶
Bases: EbayModel
feed_type
class-attribute
instance-attribute
¶
feed_type = Field(None, alias='feedType', description='The feed type associated with the task. Available feed types: Inventory upload feed types Fulfillment upload feed types Seller Hub feed types')
schema_version
class-attribute
instance-attribute
¶
schema_version = Field(None, alias='schemaVersion', description='The schemaVersion/version number of the file format: Version Details / Schema Version Seller Hub feed schema version')
CustomerServiceMetricTypeEnum ¶
DateRange ¶
Bases: EbayModel
from_
class-attribute
instance-attribute
¶
from_ = Field(None, alias='from', description='The beginning date in the range. If the parent type is included, both the from and the to fields become conditionally required. Format: UTC yyyy-MM-ddThh:mm:ss. SSSZ For example: Tasks within a range yyyy-MM-ddThh:mm:ss. SSSZ..yyyy-MM-ddThh:mm:ss. SSSZ Tasks created on March 31, 2021 2021-03-31T00:00:00.000Z..2021-03-31T00:00:00.000Z')
to
class-attribute
instance-attribute
¶
to = Field(None, description='The end date for the date range, which is inclusive. If the parent type is included, both the from and the to fields become conditionally required. For example: Tasks within a range yyyy-MM-ddThh:mm:ss. SSSZ..yyyy-MM-ddThh:mm:ss. SSSZ Tasks created on March 31, 2021 2021-03-31T00:00:00.000Z..2021-03-31T00:00:00.000Z')
DayOfWeekEnum ¶
Bases: OpenStrEnum
ErrorParameter ¶
FeedStatusEnum ¶
FrequencyEnum ¶
Bases: OpenStrEnum
InputStream ¶
Bases: EbayModel
ListingFormatEnum ¶
MarketplaceIdEnum ¶
Bases: OpenStrEnum
OrderStatusEnum ¶
ShippingRegionTypeEnum ¶
StatusEnum ¶
StatusReasonEnum ¶
StreamingOutput ¶
Bases: EbayModel
SupportedConfiguration ¶
Bases: EbayModel
default_value
class-attribute
instance-attribute
¶
default_value = Field(None, alias='defaultValue', description='The default value for the property. If a value is omitted from the schedule and a default value is supplied, the default value is used.')
property
class-attribute
instance-attribute
¶
property = Field(None, description='Properties supported by the template. Properties can include the following: scheduleStartDate: The timestamp that the report generation (subscription) begins. After this timestamp, the schedule status becomes active until either the scheduleEndDate occurs or the scheduleTemplate becomes inactive.')
usage
class-attribute
instance-attribute
¶
usage = Field(None, description='Whether the specified property is REQUIRED or OPTIONAL.')
UpdateUserScheduleRequest ¶
Bases: EbayModel
preferred_trigger_day_of_month
class-attribute
instance-attribute
¶
preferred_trigger_day_of_month = Field(None, alias='preferredTriggerDayOfMonth', description='The preferred day of the month to trigger the schedule. This field can be used with preferredTriggerHour for monthly schedules. The last day of the month is used for numbers larger than the actual number of days in the month. This field is available as specified by the template ( scheduleTemplateId ).')
preferred_trigger_day_of_week
class-attribute
instance-attribute
¶
preferred_trigger_day_of_week = Field(None, alias='preferredTriggerDayOfWeek', description='The preferred day of the week to trigger the schedule. This field can be used with preferredTriggerHour for weekly schedules. This field is available as specified by the template ( scheduleTemplateId ). The template can specify this field as optional or required and optionally provides a default value.')
preferred_trigger_hour
class-attribute
instance-attribute
¶
preferred_trigger_hour = Field(None, alias='preferredTriggerHour', description='The preferred two-digit hour of the day to trigger the schedule. This field is available as specified by the template ( scheduleTemplateId ). The template can specify this field as optional or required and optionally provides a default value. Format: UTC hhZ For example, the following represents 11:00 am UTC: 11Z Minimum: 00Z Maximum: 23Z')
schedule_end_date
class-attribute
instance-attribute
¶
schedule_end_date = Field(None, alias='scheduleEndDate', description='The timestamp on which the schedule (report generation) ends. After this date, the schedule status becomes INACTIVE . Use this field, if available, to end the schedule in the future. This value must be later than scheduleStartDate (if supplied). This field is available as specified by the template ( scheduleTemplateId ).')
schedule_name
class-attribute
instance-attribute
¶
schedule_name = Field(None, alias='scheduleName', description='The schedule name assigned by the user for the created schedule.')
schedule_start_date
class-attribute
instance-attribute
¶
schedule_start_date = Field(None, alias='scheduleStartDate', description='The timestamp to start generating the report. After this timestamp, the schedule status becomes active until either the scheduleEndDate occurs or the scheduleTemplateId becomes inactive. Use this field, if available, to start the schedule in the future but before the scheduleEndDate (if supplied). This field is available as specified by the template (scheduleTemplateId) .')
schema_version
class-attribute
instance-attribute
¶
schema_version = Field(None, alias='schemaVersion', description='The schema version of a schedule.')
UploadSummary ¶
Bases: EbayModel
failure_count
class-attribute
instance-attribute
¶
failure_count = Field(None, alias='failureCount', description='The number of records, such as the number of listings created or the number of pictures uploaded to a listing, that failed to process during the upload feed. Check the response file and correct any issues mentioned. If the feed fails before processing, no response file is provided. In this case, check the REST output response.')
success_count
class-attribute
instance-attribute
¶
success_count = Field(None, alias='successCount', description='The number of records that were successfully processed during the upload feed.')
UserScheduleResponse ¶
Bases: EbayModel
schedule_id
class-attribute
instance-attribute
¶
schedule_id = Field(None, alias='scheduleId', description='The ID of the schedule. This ID is generated when the schedule was created by the createSchedule method.')
creation_date
class-attribute
instance-attribute
¶
creation_date = Field(None, alias='creationDate', description='The creation date of the schedule in hours based on the 24‑hour Coordinated Universal Time (UTC) clock.')
feed_type
class-attribute
instance-attribute
¶
feed_type = Field(None, alias='feedType', description='The feedType associated with the schedule.')
last_modified_date
class-attribute
instance-attribute
¶
last_modified_date = Field(None, alias='lastModifiedDate', description='The date the schedule was last modified.')
preferred_trigger_day_of_month
class-attribute
instance-attribute
¶
preferred_trigger_day_of_month = Field(None, alias='preferredTriggerDayOfMonth', description='The preferred day of the month to trigger the schedule. This field can be used with preferredTriggerHour for monthly schedules. The last day of the month is used for numbers larger than the number of days in the month.')
preferred_trigger_day_of_week
class-attribute
instance-attribute
¶
preferred_trigger_day_of_week = Field(None, alias='preferredTriggerDayOfWeek', description='The preferred day of the week to trigger the schedule. This field can be used with preferredTriggerHour for weekly schedules.')
preferred_trigger_hour
class-attribute
instance-attribute
¶
preferred_trigger_hour = Field(None, alias='preferredTriggerHour', description='The preferred two-digit hour of the day to trigger the schedule. Format: UTC hhZ For example, the following represents 11:00 am UTC: 11Z')
schedule_end_date
class-attribute
instance-attribute
¶
schedule_end_date = Field(None, alias='scheduleEndDate', description='The timestamp on which the report generation (subscription) ends. After this date, the schedule status becomes INACTIVE .')
schedule_name
class-attribute
instance-attribute
¶
schedule_name = Field(None, alias='scheduleName', description='The schedule name assigned by the user for the created schedule. Users assign this name for their reference.')
schedule_start_date
class-attribute
instance-attribute
¶
schedule_start_date = Field(None, alias='scheduleStartDate', description='The timestamp that indicates the start of the report generation.')
schedule_template_id
class-attribute
instance-attribute
¶
schedule_template_id = Field(None, alias='scheduleTemplateId', description='The ID of the template used to create this schedule.')
schema_version
class-attribute
instance-attribute
¶
schema_version = Field(None, alias='schemaVersion', description='The schema version of the feedType for the schedule.')
status
class-attribute
instance-attribute
¶
status = Field(None, description='The enumeration value that indicates the state of the schedule.')
status_reason
class-attribute
instance-attribute
¶
status_reason = Field(None, alias='statusReason', description='The reason the schedule is inactive.')
CreateUserScheduleRequest ¶
Bases: EbayModel
feed_type
class-attribute
instance-attribute
¶
feed_type = Field(None, alias='feedType', description='The name of the feed type for the created schedule. Use the getScheduleTemplates method to retrieve the feed type of a schedule template. Note: Schedules are currently only available for LMS_ORDER_REPORT .')
preferred_trigger_day_of_month
class-attribute
instance-attribute
¶
preferred_trigger_day_of_month = Field(None, alias='preferredTriggerDayOfMonth', description='The preferred day of the month to trigger the schedule. This field can be used with preferredTriggerHour for monthly schedules. The last day of the month is used for numbers larger than the actual number of days in the month. This field is available as specified by the template ( scheduleTemplateId ).')
preferred_trigger_day_of_week
class-attribute
instance-attribute
¶
preferred_trigger_day_of_week = Field(None, alias='preferredTriggerDayOfWeek', description='The preferred day of the week to trigger the schedule. This field can be used with preferredTriggerHour for weekly schedules. This field is available as specified by the template ( scheduleTemplateId ). The template can specify this field as optional or required and optionally provides a default value.')
preferred_trigger_hour
class-attribute
instance-attribute
¶
preferred_trigger_hour = Field(None, alias='preferredTriggerHour', description='The preferred two-digit hour of the day to trigger the schedule. This field is available as specified by the template ( scheduleTemplateId ). The template can specify this field as optional or required and optionally provides a default value. Format: UTC hhZ For example, the following represents 11:00 am UTC: 11Z')
schedule_end_date
class-attribute
instance-attribute
¶
schedule_end_date = Field(None, alias='scheduleEndDate', description='The timestamp on which the report generation (subscription) ends. After this date, the schedule status becomes INACTIVE . Use this field, if available, to end the schedule in the future. This value must be later than scheduleStartDate (if supplied). This field is available as specified by the template ( scheduleTemplateId ).')
schedule_name
class-attribute
instance-attribute
¶
schedule_name = Field(None, alias='scheduleName', description='The schedule name assigned by the user for the created schedule.')
schedule_start_date
class-attribute
instance-attribute
¶
schedule_start_date = Field(None, alias='scheduleStartDate', description='The timestamp to start generating the report. After this timestamp, the schedule status becomes active until either the scheduleEndDate occurs or the scheduleTemplateId becomes inactive. Use this field, if available, to start the schedule in the future but before the scheduleEndDate (if supplied). This field is available as specified by the template (scheduleTemplateId) .')
schedule_template_id
class-attribute
instance-attribute
¶
schedule_template_id = Field(None, alias='scheduleTemplateId', description='The unique identifier of the template to be used for this schedule. Use the getScheduleTemplates method to retrieve the schedule template ID. This method requires a schedule template ID that is ACTIVE . Note: Schedules are currently only available for LMS_ORDER_REPORT .')
schema_version
class-attribute
instance-attribute
¶
schema_version = Field(None, alias='schemaVersion', description='The schema version of a schedule.')
CustomerServiceMetricsFilterCriteria ¶
Bases: EbayModel
customer_service_metric_type
class-attribute
instance-attribute
¶
customer_service_metric_type = Field(None, alias='customerServiceMetricType', description='An enumeration value that specifies the customer service metric that eBay tracks to measure seller performance.')
evaluation_marketplace_id
class-attribute
instance-attribute
¶
evaluation_marketplace_id = Field(None, alias='evaluationMarketplaceId', description='An enumeration value that specifies the eBay marketplace where the evaluation occurs.')
listing_categories
class-attribute
instance-attribute
¶
listing_categories = Field(None, alias='listingCategories', description='A list of listing category IDs on which the service metric is measured. A seller can use one or more L1 (top-level) eBay categories to get metrics specific to those L1 categories. The Category IDs for each L1 category are required. Category ID values for L1 categories can be retrieved using the Taxonomy API.')
shipping_regions
class-attribute
instance-attribute
¶
shipping_regions = Field(None, alias='shippingRegions', description='A list of shipping region enumeration values on which the service metric is measured. This comma delimited array allows the seller to customize the report to focus on domestic or international shipping. Note: Pass this attribute to narrow down your filter results for the ITEM_NOT_RECEIVED customerServiceMetricType. Supported categories include: primary(L1) category Id')
Error ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description='Identifies the type of erro.')
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='Name for the primary system where the error occurred. This is relevant for application errors.')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', description='A unique number to identify the error.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description='An array of request elements most closely associated to the error.')
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='A more detailed explanation of the error.')
message
class-attribute
instance-attribute
¶
message = Field(None, description="Information on how to correct the problem, in the end user's terms and language where applicable.")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='An array of request elements most closely associated to the error.')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description='Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.')
InventoryFilterCriteria ¶
Bases: EbayModel
listing_format
class-attribute
instance-attribute
¶
listing_format = Field(None, alias='listingFormat', description='The listing format for the ActiveInventoryReport being created. Supported types are: AUCTION FIXED_PRICE')
InventoryTask ¶
Bases: EbayModel
task_id
class-attribute
instance-attribute
¶
task_id = Field(None, alias='taskId', description='The ID of the task. This ID is generated when the task was created by the createInventoryTask method.')
status
class-attribute
instance-attribute
¶
status = Field(None, description='The status of the task. Users must wait until status is complete before moving on to the next step (such as uploading/downloading a file).')
feed_type
class-attribute
instance-attribute
¶
feed_type = Field(None, alias='feedType', description='The feed type associated with the inventory task.')
creation_date
class-attribute
instance-attribute
¶
creation_date = Field(None, alias='creationDate', description='The date the task was created.')
completion_date
class-attribute
instance-attribute
¶
completion_date = Field(None, alias='completionDate', description='The timestamp when the task status went into the COMPLETED , COMPLETED_WITH_ERROR , or PARTIALLY_PROCESSED state. This field is only returned if the status is one of the three completed values.')
schema_version
class-attribute
instance-attribute
¶
schema_version = Field(None, alias='schemaVersion', description='The schema version number associated with the task.')
detail_href
class-attribute
instance-attribute
¶
detail_href = Field(None, alias='detailHref', description='The path to the call URI used to retrieve the task. This field points to the getInventoryTask URI.')
upload_summary
class-attribute
instance-attribute
¶
upload_summary = Field(None, alias='uploadSummary', description='This container provides summary information on an upload feed (not applicable for download feed types).')
filter_criteria
class-attribute
instance-attribute
¶
filter_criteria = Field(None, alias='filterCriteria', description='This container is used to set the filter criteria for the ActiveInventoryReport. A seller can retrieve listings for a specified format.')
InventoryTaskCollection ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='The path to the call URI that produced the current page of results.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The value of the limit parameter submitted in the request, which is the maximum number of inventory tasks to return per page, from the result set. A result set is the complete set of tasks returned by the method. Note: Though this parameter is not required to be submitted in the request, the parameter defaults to 10 if omitted.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The path to the call URI for the next page of results. This value is returned if there is an additional page of results to return from the result set.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='The number of results skipped in the result set before listing the first returned result. This value can be specified in the request with the offset query parameter. Note: The items in a paginated result set use a zero-based list, where the first item in the list has an offset of 0 .')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The path to the call URI for the previous page of results. This is returned if there is a previous page of results from the result set.')
tasks
class-attribute
instance-attribute
¶
tasks = Field(None, description='An array of the inventory tasks on this page. The tasks are sorted by creation date. Note: An empty array is returned if the filter criteria excludes all tasks.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of inventory tasks that match the input criteria.')
OrderFilterCriteria ¶
Bases: EbayModel
creation_date_range
class-attribute
instance-attribute
¶
creation_date_range = Field(None, alias='creationDateRange', description='The creation date range of the orders you want returned. Set the date range so it contains less than 10 days (maximum). If you do not specify a DateRange , results from the last 10 days will be returned by default.')
modified_date_range
class-attribute
instance-attribute
¶
modified_date_range = Field(None, alias='modifiedDateRange', description='The modified date range of the orders you want returned. Note: This container is for future use. At this time, the createOrderTask method only supports order creation date filters and not modified order date filters.')
order_status
class-attribute
instance-attribute
¶
order_status = Field(None, alias='orderStatus', description='The order status of the orders returned. If the filter is omitted from the createOrderTask call, orders that are in both ACTIVE and COMPLETED states are returned.')
OrderTask ¶
Bases: EbayModel
completion_date
class-attribute
instance-attribute
¶
completion_date = Field(None, alias='completionDate', description='The timestamp when the task went into the COMPLETED or COMPLETED_WITH_ERROR state. This state means that eBay has compiled the report for the seller based on the seller’s filter criteria, and the seller can run a getResultFile call to download the report.')
creation_date
class-attribute
instance-attribute
¶
creation_date = Field(None, alias='creationDate', description='The date the task was created.')
detail_href
class-attribute
instance-attribute
¶
detail_href = Field(None, alias='detailHref', description='The path to the call URI used to retrieve the task.')
feed_type
class-attribute
instance-attribute
¶
feed_type = Field(None, alias='feedType', description='The feed type associated with the task.')
filter_criteria
class-attribute
instance-attribute
¶
filter_criteria = Field(None, alias='filterCriteria', description='A container that returns the filter criteria used.')
schema_version
class-attribute
instance-attribute
¶
schema_version = Field(None, alias='schemaVersion', description='The schema version number associated with the create task.')
status
class-attribute
instance-attribute
¶
status = Field(None, description='The enumeration value that indicates the state of the task that was submitted in the request. See FeedStatusEnum for information. The values COMPLETED and COMPLETED_WITH_ERROR indicate the Order Report file is ready to download.')
task_id
class-attribute
instance-attribute
¶
task_id = Field(None, alias='taskId', description='The ID of the task that was submitted in the request.')
upload_summary
class-attribute
instance-attribute
¶
upload_summary = Field(None, alias='uploadSummary', description='This container provides summary information on an upload feed (not applicable for download feed types).')
OrderTaskCollection ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='The path to the call URI that produced the current page of results.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The value of the limit parameter submitted in the request, which is the maximum number of order tasks to return per page, from the result set. A result set is the complete set of tasks returned by the method. Note: Though this parameter is not required to be submitted in the request, the parameter defaults to 10 if omitted.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The path to the call URI for the next page of results. This value is returned if there is an additional page of results to return from the result set.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter. Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0 .')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The path to the call URI for the previous page of results. This is returned if there is a previous page of results from the result set.')
tasks
class-attribute
instance-attribute
¶
tasks = Field(None, description='An array of the order tasks on this page. The tasks are sorted by creation date. An empty array is returned if the filter criteria excludes all tasks.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of order tasks that match the input criteria.')
ScheduleTemplateResponse ¶
Bases: EbayModel
feed_type
class-attribute
instance-attribute
¶
feed_type = Field(None, alias='feedType', description='The feed type of the schedule template. Note: When calling createSchedule and updateSchedule methods, you must match the feed type specified by the schedule template (this feedType ).')
frequency
class-attribute
instance-attribute
¶
frequency = Field(None, description='This field specifies how often the schedule is generated. If set to HALF_HOUR or ONE_HOUR , you cannot set a preferredTriggerHour using createSchedule or updateSchedule .')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The template name provided by the template.')
schedule_template_id
class-attribute
instance-attribute
¶
schedule_template_id = Field(None, alias='scheduleTemplateId', description='The ID of the template. Use this ID to create a schedule based on the properties of this schedule template.')
status
class-attribute
instance-attribute
¶
status = Field(None, description='The present status of the template. You cannot create or modify a schedule using a template with an INACTIVE status.')
supported_configurations
class-attribute
instance-attribute
¶
supported_configurations = Field(None, alias='supportedConfigurations', description='An array of the configuration supported by this template.')
ServiceMetricsTask ¶
Bases: EbayModel
completion_date
class-attribute
instance-attribute
¶
completion_date = Field(None, alias='completionDate', description='The timestamp when the customer service metrics task went into the COMPLETED or COMPLETED_WITH_ERROR state. This field is only returned if the status is one of the two completed values. This state means that eBay has compiled the report for the seller based on the seller’s filter criteria, and the seller can run a getResultFile call to download the report.')
creation_date
class-attribute
instance-attribute
¶
creation_date = Field(None, alias='creationDate', description='The date the customer service metrics task was created.')
detail_href
class-attribute
instance-attribute
¶
detail_href = Field(None, alias='detailHref', description='The relative getCustomerServiceMetricTask call URI path to retrieve the corresponding task.')
feed_type
class-attribute
instance-attribute
¶
feed_type = Field(None, alias='feedType', description='The feed type associated with the task.')
filter_criteria
class-attribute
instance-attribute
¶
filter_criteria = Field(None, alias='filterCriteria', description='This container shows the criteria set for the report.')
schema_version
class-attribute
instance-attribute
¶
schema_version = Field(None, alias='schemaVersion', description='The schema version number of the file format. If omitted, the default value is used. Default value: 1.0')
status
class-attribute
instance-attribute
¶
status = Field(None, description='An enumeration value that indicates the state of the task.')
task_id
class-attribute
instance-attribute
¶
task_id = Field(None, alias='taskId', description='The unique eBay-assigned ID of the task.')
Task ¶
Bases: EbayModel
completion_date
class-attribute
instance-attribute
¶
completion_date = Field(None, alias='completionDate', description='The timestamp when the task went into the COMPLETED or COMPLETED_WITH_ERROR state. This state means that eBay has compiled the report for the seller based on the seller’s filter criteria, and the seller can run a getResultFile call to download the report.')
creation_date
class-attribute
instance-attribute
¶
creation_date = Field(None, alias='creationDate', description='The date the task was created.')
detail_href
class-attribute
instance-attribute
¶
detail_href = Field(None, alias='detailHref', description='The path to the call URI used to retrieve the task. This field points to the GetOrderTask URI if the task is for LMS_ORDER_REPORT , or it will be null if this task is for LMS_ORDER_ACK .')
feed_type
class-attribute
instance-attribute
¶
feed_type = Field(None, alias='feedType', description='The feed type associated with the task.')
schema_version
class-attribute
instance-attribute
¶
schema_version = Field(None, alias='schemaVersion', description='The schema version number associated with the task.')
status
class-attribute
instance-attribute
¶
status = Field(None, description='The enumeration value that indicates the state of the task that was submitted in the request. See FeedStatusEnum for information. The values COMPLETED and COMPLETED_WITH_ERROR indicate the Order Report file is ready to download.')
task_id
class-attribute
instance-attribute
¶
task_id = Field(None, alias='taskId', description='The ID of the task that was submitted in the request.')
upload_summary
class-attribute
instance-attribute
¶
upload_summary = Field(None, alias='uploadSummary', description='This container provides summary information on an upload feed (not applicable for download feed types).')
TaskCollection ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='The path to the call URI that produced the current page of results.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The value of the limit parameter submitted in the request, which is the maximum number of tasks to return per page, from the result set. A result set is the complete set of tasks returned by the method. Note: Though this parameter is not required to be submitted in the request, the parameter defaults to 10 if omitted.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The path to the call URI for the next page of results. This value is returned if there is an additional page of results to return from the result set.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter. Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0 .')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The path to the call URI for the previous page of results. This is returned if there is a previous page of results from the result set.')
tasks
class-attribute
instance-attribute
¶
tasks = Field(None, description='An array of the tasks on this page. The tasks are sorted by creation date. An empty array is returned if the filter criteria excludes all tasks.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of tasks that match the input criteria.')
UserScheduleCollection ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='The path to the call URI that produced the current page of results.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The value of the limit parameter submitted in the request, which is the maximum number of schedules to return per page, from the result set. A result set is the complete set of schedules returned by the method. Note: Though this parameter is not required to be submitted in the request, the parameter defaults to 10 if omitted.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The path to the call URI for the next page of results. This value is returned if there is an additional page of results to return from the result set.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter. Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0 .')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The path to the call URI for the previous page of results. This is returned if there is a previous page of results from the result set.')
schedules
class-attribute
instance-attribute
¶
schedules = Field(None, description='An array of the schedules on this page. An empty array is returned if the filter criteria excludes all tasks.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of schedules that match the input criteria.')
CreateInventoryTaskRequest ¶
Bases: EbayModel
feed_type
class-attribute
instance-attribute
¶
feed_type = Field(None, alias='feedType', description='The feed type associated with the inventory task you are about to create. Presently, only one feed type is available: LMS_ACTIVE_INVENTORY_REPORT See Report download feed types for more information.')
filter_criteria
class-attribute
instance-attribute
¶
filter_criteria = Field(None, alias='filterCriteria', description='This container allows a seller to create an ActiveInventoryReport for a single listing format.')
schema_version
class-attribute
instance-attribute
¶
schema_version = Field(None, alias='schemaVersion', description='The version number of the inventory task to use for the feedType . Note: This field must have a value of 1.0 .')
CreateOrderTaskRequest ¶
Bases: EbayModel
feed_type
class-attribute
instance-attribute
¶
feed_type = Field(None, alias='feedType', description='The feed type associated with the task. The only presently supported value is LMS_ORDER_REPORT . See Report download feed types for more information.')
filter_criteria
class-attribute
instance-attribute
¶
filter_criteria = Field(None, alias='filterCriteria', description='The container for the filter fields. This container is used to set the filter criteria for the order report. A seller can set date range filters and/or can retrieve orders in a specific state.')
schema_version
class-attribute
instance-attribute
¶
schema_version = Field(None, alias='schemaVersion', description='The schema version of the LMS OrderReport. For the LMS_ORDER_REPORT feed type, see the OrderReport reference page to see the present schema version. The schemaVersion value is the version number shown at the top of the OrderReport page. Restriction: This value must be 1113 or higher. The OrderReport schema version is updated about every two weeks.')
CreateServiceMetricsTaskRequest ¶
Bases: EbayModel
feed_type
class-attribute
instance-attribute
¶
feed_type = Field(None, alias='feedType', description='The feedType specified for the customer service metric task being created. The report lists the transaction details that contribute to the service metrics evaluation. Supported types include: CUSTOMER_SERVICE_METRICS_REPORT')
filter_criteria
class-attribute
instance-attribute
¶
filter_criteria = Field(None, alias='filterCriteria', description='This container is used to customize and set criteria for the Customer Service Metric report that will be associated with the task.')
schema_version
class-attribute
instance-attribute
¶
schema_version = Field(None, alias='schemaVersion', description='The version number of the customer service metric. Note: This field must have a value of 1.0 .')
CustomerServiceMetricTaskCollection ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='The URI of the current page of results.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The value of the limit parameter submitted in the request, which is the maximum number of tasks to return per page, from the result set. A result set is the complete set of tasks returned by the method. Note: Even though this parameter is not required to be submitted in the request, the parameter defaults to 10 if omitted.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The relative path to the call URI for the next page of results. This value is returned if there is an additional page of results to return from the result set.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='The number of results skipped in the result set before returning the first result. This value can be set in the request with the offset query parameter. Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0 .')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The URI for the previous page of results. This parameter is returned if a previous page of results from the result set exists.')
tasks
class-attribute
instance-attribute
¶
tasks = Field(None, description='An array of the customer service tasks on this page. The tasks are sorted by creation date. An empty array is returned if the filter criteria excludes all tasks.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of tasks that match the criteria.')
ScheduleTemplateCollection ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='The path to the call URI that produced the current page of results.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The value of the limit parameter submitted in the request, which is the maximum number of schedule templates to return per page, from the result set. A result set is the complete set of schedule templates returned by the method. Note: Though this parameter is not required to be submitted in the request, the parameter defaults to 10 if omitted.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The path to the call URI for the next page of results. This value is returned if there is an additional page of results to return from the result set.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter. Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0 .')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The path to the call URI for the previous page of results. This is returned if there is a previous page of results from the result set.')
schedule_templates
class-attribute
instance-attribute
¶
schedule_templates = Field(None, alias='scheduleTemplates', description='An array of the schedule templates on this page. An empty array is returned if the filter criteria excludes all tasks.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of schedule templates that match the input criteria.')