Reinstate a deleted Export

POST 
/export/:guid/reinstate

Reinstate a deleted Export.

Request

Path Parameters

guid uuidrequired

The guid of the Export.

Responses

200

Export reinstated.

application/json

Schema

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.

Example (from schema)

{
  "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "company_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "description": "string",
  "type": "orders",
  "timezone": "string",
  "order_count": 0,
  "processed_order_count": 0,
  "location": "string",
  "download_links": [
    {
      "<filetype>": "string"
    }
  ],
  "created_at": "string",
  "updated_at": "string",
  "deleted_at": "string"
}

403

Unauthorized. You do not have permission to manage Exports of the Company.

application/json

Schema

Schema

error_code string

The general error code.

error_description stringrequired

The exact reason of failure.

Example (from schema)

{
  "error_code": "string",
  "error_description": "string"
}

404

Export not found or not deleted.

application/json

Schema

Schema

error_code string

The general error code.

error_description stringrequired

The exact reason of failure.

Example (from schema)

{
  "error_code": "string",
  "error_description": "string"
}

500

Internal server error. Reinstating the Export failed.

application/json

Schema

Schema

error_code string

The general error code.

error_description stringrequired

The exact reason of failure.

Example (from schema)

{
  "error_code": "string",
  "error_description": "string"
}

Loading...