POST v3/orderAttachments
POST/v3/orderAttachments
Attach a PDF to an order, to be printed during picking.
The POST /v3/orderAttachments endpoint allows linking an attachment to an
order for printing during the picking process.
⚠ orderAttachments is part of the POST /v3/orders.
⚠ See endpoint POST /v3/orders.
Request
When submitting an orderAttachment, the order to which it will be attached must be created prior to
attaching, but before the order is fulfilled.
Response
Upon successful creation of the orderAttachment the response will contain the
created orderAttachment resource and the relation to the order. The contents of the attachment is
suppressed from the response..
Limitations to POST v3/orderAttachments
There are limitations to what and when orderAttachments can be attached to orders:
- As long as the
orderis not completely fulfilled and some items remain to be shipped, anorderAttachmentcan be added to the order. Attempting to add anorderAttachmentafterwards will result in an error. - Only valid
pdfdocuments can be submitted asorderAttachment. - Only document with a single page sizes in
A4orA5are supported. So mixing ofA4withA5formats is not possible in a singleorderAttachment. - There is a file sizelimit and page limit to each
orderAttachment.
Request
Responses
- 200
- 401
- 403
- 404
- 406
- 415
- 422
Upon successful submission of the orderAttachment the details are returned, excluding the
attachment's contents. If the externalOrderNumber was provided it is also not returned,
but instead its relation to the order is added under relationships.
401 Unauthorized
A 401 Unauthorized response occurs when attempting to access a resource or perform an action that requires authentication, but no valid credentials have been provided. It indicates that the requester is unauthorized to access the requested resource.
The following are common scenarios that may lead to a 401 Unauthorized response:
- Attempting to access a protected API endpoint without providing authentication credentials.
- Providing an invalid or expired authentication token.
- Providing valid authentication credentials, but lacking sufficient privileges to access the requested resource.
- Providing authentication credentials that are valid for a different resource or API endpoint than the one being requested.
403 Forbidden
The HTTP 403 Forbidden client error response status code indicates that the server understood the request but refused to process it. This status is similar to 401 Unauthorized, except that for 403 Forbidden responses, authenticating or re-authenticating makes no difference. The request failure is tied to application logic, such as insufficient permissions to a resource or action.
When referenced resources are not found the server will return with a HTTP:404 error.
406 Not Acceptable
A 406 Not Acceptable response occurs when the server cannot provide a response that matches the client's requested format or content language for the requested resource. For instance, if a client sends an Accept header of text/html to an API endpoint that only supports application/json responses, the server would respond with a 406 Not Acceptable status code. This type of response is a required response for JSON:API compatible endpoints.
415 Unsupported Media Type
A 415 Unsupported Media Type response occurs when the server cannot process the request because the media type specified in the request is not supported for the requested resource. For example, if a client sends a request with a Content-Type header of application/pdf to an API endpoint that only supports application/json (the only valid media type for JSON:API), the server would respond with a 415 Unsupported Media Type status code. This type of error-response is a required for JSON:API compatible endpoints.
In case of business rule violations the server will respond with a HTTP:422 error.