Create Sales Order Release

SecurityAPIKeyHeader
Request
path Parameters
order_id
required
string (Order Id)
Request Body schema: multipart/form-data
required
required
object (CreateSalesOrderRelease)
object (CreateDocumentsMetadataSchema)

Schema for creating document metadata

documents
Array of strings <binary> (Documents)
Default: []
Responses
201

Successful Response

Response Schema: application/json
custom_data
object (Custom Data)

Key-value pair of custom data. See the custom_data guide

release_type
string (Release Type)
Default: "ORDER"

Type of the release

Value: "ORDER"
ready_to_ship_at
string <date-time> (Ready To Ship At)
object (OrderReleaseStop)
id
required
string (Id)
created_from_order_id
required
string (Created From Order Id)
status
required
string (OrderReleaseStatus)

Possible statuses for a Product Order Release.

Enum: "NEED" "ACCEPTED" "REJECTED" "CANCELLED"
released_onto_order_id
string (Released Onto Order Id)
accepted_at
string <date-time> (Accepted At)
rejected_at
string <date-time> (Rejected At)
cancelled_at
string <date-time> (Cancelled At)
required
Array of objects (Items) non-empty
required
Array of objects (Documents)
400

Validation Error

post/sales-orders/{order_id}/releases
Request samples 
Response samples 
application/json
{
  • "custom_data": "{\"abc\": \"any value\", \"def\": \"any value\"}",
  • "release_type": "ORDER",
  • "ready_to_ship_at": "2019-08-24T14:15:22Z",
  • "ship_from": {
    },
  • "id": "string",
  • "created_from_order_id": "string",
  • "status": "NEED",
  • "released_onto_order_id": "string",
  • "accepted_at": "2019-08-24T14:15:22Z",
  • "rejected_at": "2019-08-24T14:15:22Z",
  • "cancelled_at": "2019-08-24T14:15:22Z",
  • "items": [
    ],
  • "documents": [
    ]
}
Copyright © Shipwell 2024. All right reserved.