Receiving orders in finished photos

The method is used to get a list of orders with links to archives ready for download.

Request for a list of orders with finished photos

In order to use this process, a POST request should be sent to URL:

Environment	URL
testing	https://api.edu.cdek.ru/v2/photoDocument
production	https://api.cdek.ru/v2/photoDocument

Request Parameters

Must be sent in JSON format (Content-Type: application/json).

The following fields are supported:

No.	Field name	Description	Field type	Mandatory (yes/no)
1	periodBegin	Search period start	dateTime	yes , if not passed orders
2	periodEnd	End of search period	dateTime	yes , if not passed orders
3	orders	Order list	[ ]	yes , if not passed periodBegin and periodEnd
3.1	order_uuid	Order identifier in CDEK	UUID	yes , if not passed orders and not passed cdek_number
3.2	cdek_number	CDEK order number	string	yes , if not passed orders and not passed order_uuid

* If both the period and the list of orders are specified, then the period is ignored.

Response for a list of orders with finished photos

The response is returned in JSON format:

No.	Field name	Description	Field type	Mandatory (yes/no)
1	orders	List of orders ready for download	[ ]	yes
1.1	order_uuid	Order identifier in CDEK	UUID	yes
1.2	cdek_number	CDEK order number	string	yes
1.3	link	Link to download archive with photos	string (1024)	yes
2	errors	Request processing errors	error[]	no
2.1	code	Error code	string()	yes
2.2	message	Error description	string()	yes
3	warnings	Request processing warnings	warning[]	no
3.1	code	Warning code	string()	yes
3.2	message	Warning description	string()	yes

{
  "periodBegin": "2021-01-21T02:15:47.818Z",
  "periodEnd": "2021-01-21T02:15:47.818Z"
}

{
    "orders": [
        {
            "cdek_number": "1107546886",
            "link": "https://photo-docs.production.cdek.ru/archives/PpB5LdIuphBM3SMy",
            "order_uuid": "72753031-c3b5-447d-8ae7-98ac3e36b102"
        },
        {
            "cdek_number": "1107547001",
            "link": "https://photo-docs.production.cdek.ru/archives/StmFQSqvd0wk",
            "order_uuid": "72753031-6485-4c55-a082-7c21714d3703"
        }
    ]
}