Update a file for a specified customer and order

put

https://platform.roserocket.com/api/v1/customers/{customerID}/orders/{orderID}/files/{fileID}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

orderID

string

required

ID of the order to get files for. It could also be the external ID of the order, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the order's external ID is test123 then the value of orderID should be ext:test1234 or external_id:test1234.

fileID

string

required

ID of the order file.

customerID

string

required

ID of the customer to of the order. It could also be the external ID of the order, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the order's external ID is test123 then the value of orderID should be ext:test1234 or external_id:test1234.

Body Params

Order file create request

A request to create a file/document for an order

type

string

enum

The type of order file

url

string

The url location for the order file

description

string

A description of the order file

latitude

float

Coordinate (latitude). This field value can be null

longitude

float

Coordinate (longitude). This field value can be null

metadata

object

Metadata object for the order file

Responses

200successful operation

400Bad request