Skip to main content

Get a specific Export

GET 
/export/:guid

Retrieve a specific Export.

Request​

Path Parameters

    guid uuidrequired

    The guid of the Export.

Responses​

Export found.

Schema

    guid uuidrequired

    The guid of the Export.

    company_id uuid

    The guid of the Company associated with this Export.

    name stringrequired

    Possible values: >= 3 characters and <= 255 characters

    The name of the Export.

    description string

    Possible values: >= 3 characters and <= 255 characters

    The description of the Export.

    type stringrequired

    Possible values: [orders, order_tickets, orders_and_order_tickets, orders_and_order_tickets_and_order_products, direct_mail, order_tickets_scanned, orders_location, order_products_optional]

    The type of the Export.

    timezone string

    The timezone the dates and times in this Export are formatted to.

    order_count integer

    The total Order count for Export.

    processed_order_count integer

    How many Orders are already added to Export.

    location string

    The download hash of the Export.

    download_links

    object[]

    The download links of the Export.

  • Array [

    • <filetype> url

    The download link for this filetype.

  • ]

    • created_at ISO 8601

    The time it was created.

    updated_at ISO 8601

    The time it was last updated.

    deleted_at ISO 8601

    The time it was deleted.

    export_filetypes

    object[]

  • Array [

    • guid uuidrequired

    The guid of the ExportFiletype.

    export_id uuid

    The guid of the Export associated with the ExportFiletype.

    filetype stringrequired

    Possible values: <= 255 characters, [csv, xslx]

    The name of the ExportFiletype.

    status stringrequired

    Possible values: <= 255 characters, [pending, created]

    The status of the Export for this ExportFiletype.

    created_at ISO 8601

    The time it was created.

    updated_at ISO 8601

    The time it was last updated.

  • ]

Loading...