Orders

Upload Document

Uploads a Base64 encoded document to a goodsout.

POST

/v1/orders/goodsouts/{id}/documents

Upload Document

curl --request POST \
  --url https://public-api.bladepro.io/v1/orders/goodsouts/{id}/documents \
  --header 'Content-Type: application/json' \
  --data '
{
  "category": "<any>",
  "extension": "<string>",
  "file": "<string>",
  "mime": "<string>",
  "name": "<string>",
  "paper_size": "<any>",
  "print_at_despatch": 123
}
'

{
  "data": {
    "success": true
  },
  "meta": {
    "request_reference": "233f2gjwz-c893v86"
  }
}

Scope(s): APP::ORDERS::MANAGE

Path Parameters

idstringrequired

Path parameter: id

Pattern: [1-9][0-9]{0,}

Body

categoryanyrequired

The document category.

extensionstringrequired

The file extension.

filestringrequired

The file contents Base64 encoded.

mimestringrequired

The file mime.

namestringrequired

The file name.

paper_sizeany

The paper size.

print_at_despatchnumber

The number of copies to print at desptach.

Response

successful operation

successboolean

Whether the upload was successful or not.

Still need help? Share an idea