Document

Some resources, such as order and inbounds, are provided with documents. Think of customs documents or quality controls. This page describes the endpoints to manage these documents.

The document model

Properties

  • Name
    id
    Type
    string
    Readonly
    readonly
    Description

    Unique identifier for the document.

  • Name
    name
    Type
    string
    Description
  • Name
    mime_type
    Type
    string
    Description
  • Name
    document_type
    Type
    string
    Description

    Type of document, for example invoice or packing_slip.

  • Name
    url
    Type
    string
    Readonly
    readonly
    Description

    URL of S3 object.

  • Name
    created_at
    Type
    datetime
    Readonly
    readonly
    Description
  • Name
    modified_at
    Type
    datetime
    Readonly
    readonly
    Description
GET/wms/documents/:id/

Retrieve a document

Retrieve a document.

Request

GET
/wms/documents/:id/
curl https://eu-dev.middleware.ewarehousing-solutions.com/wms/documents/af7c1fe6-d669-414e-b066-e9733f0de7a8/

Response

{
    "id": "3f5a2c75-d2b0-44b3-aba7-d02fdf9fac33",
    "title": "dummy.png",
    "mime_type": "image/png",
    "created_at": "2023-07-25T09:20:52+00:00",
    "url": "https://storage.googleapis.com/storage/documents/inbound/64c7c210e39a2.pdf?GoogleAccessId=test-780%40wms-development-355515.iam.gserviceaccount.com&Expires=1690818137&Signature=K7g9IuBbqzGsim5%2BAd6YaEV1G09MXWGHZ4p7d3esaZuQdpbN0f9xAixWhsRndrP%2FPHRFKl4yVuv1l3lDCFyMrh%2B%2FSdLMJmW2XP01Gp7pTx%2B02hiBnJKS1mW4nvEK8vr5w6hybORMCijOXuEQ5R%2F5ybRPh8mwEYXE0RJHMCeAYvNu0komzoJ9s15YWM%2FTZisOFXIcIPI%2BCd%2Fr8HE3focGVVv6lL23WTVfmBConYvrvos9vf%2BSp4pinWfSdOTmZgQk5bQkpflm%2FflOblU4fOA%2FI7yf%2FsfJL%2BNHpB%2FFHc9R%2BOCf4aoF1IydL39Gl3hTEKdwUiXqGqppl7yLoOfv8047MQ%3D%3D"
}
DELETE/wms/documents/:id/

Delete a document

This endpoint allows you to delete a document.

Request

DELETE
/wms/documents/:id/
curl -X DELETE https://eu-dev.middleware.ewarehousing-solutions.com/wms/documents/33a59408-c708-4da4-9f1f-50e87c968928/