Skip to main content
GET
/
attachments
/
{id}
Get a single Attachment by its id
curl --request GET \
  --url https://commerce.driv.ly/api/attachments/{id} \
  --header 'Authorization: <api-key>'
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "name": "<string>",
  "status": "Error",
  "type": "<string>",
  "file": "<string>",
  "serviceOrders": "<string>",
  "orderId": "<string>",
  "transportServiceOrders": [
    123
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.drivly.dev/llms.txt

Use this file to discover all available pages before exploring further.

Make sure you install our SDK first. You can find out how, and more here.
import { SDK } from '@drivly/commerce'
import type { attachments } from '@drivly/commerce'

const sdk = new SDK(...)

const attachments = await sdk.attachments.findOne(attachmentsId: string): Promise<attachments>

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string
required

id of the Attachment

Query Parameters

​
depth
number

number of levels to automatically populate relationships and uploads

​
locale
string

retrieves document(s) in a specific locale

​
fallback-locale
string

specifies a fallback locale if no locale value exists

​
sort
string

sort by field

​
where
Where clause · object

pass a where query to constrain returned documents (complex type, see documentation)

Example:
{
  "or": [
    { "color": { "equals": "mint" } },
    {
      "and": [
        { "color": { "equals": "white" } },
        { "featured": { "equals": false } }
      ]
    }
  ]
}
​
limit
number

limit the returned documents to a certain number

​
page
number

get a specific page of documents

Response

ok

​
updatedAt
string
required
​
createdAt
string
required
​
name
string | null
​
status
enum<string> | null
Available options:
Error,
Sending,
Sent
​
type
string | null
​
file
string | null
​
serviceOrders
string | null
​
orderId
string | null
​
transportServiceOrders
(number | ServiceOrder · object)[] | null