Sign in

v1

latestOpenAPI 3.0.12026-08-0688138402.2 KB
Sales orders

Create a fulfillment

Creates a fulfillment, based on a sales_order.

Fulfillments are used for completing orders and creating shipments.

post/sales_orders/{id}/fulfillments

Path parameters

idinteger required

ID for the sales order to be included in the filter

Request body

fulfilled_by_third_partyboolean

Defines if fulfillment is fulfilled by a third party.

order_packaging_idinteger

ID of a desired order_packaging. Specifies which order packaging to use.

Example request

{
  "order_packaging_id": 16,
  "fulfillment_lines": [
    {
      "order_line_id": 45891,
      "shipped_quantity": "1.0"
    }
  ]
}

Response

Successful.

idinteger

Unique identifier of the fulfillment.

sales_order_idinteger

Unique identifier of the related sales order.

codestring

The generated code for the fulfillment. Generated from the related order ID

type'outbound' | 'return'

The type of the fulfillment.

shipment_idinteger

Unique identifier of the created shipment.

fulfilled_by_third_partyboolean

Defines if fulfillment is fulfilled by a third party.

order_packaging_idinteger

ID of a desired order_packaging. Specifies which order packaging that has been used.

cancelledboolean

Defines if fulfillment is cancelled.

created_atstring date-time

ISO 8601 datetime the object was created.

updated_atstring date-time

ISO 8601 datetime when the object was updated.

return_resolution_namestring

Name of the chosen return resolution for return fulfillments.

Example response

{
  "id": 11120,
  "sales_order_id": 11227,
  "code": "27000-1",
  "shipment_id": 14500,
  "order_packaging_id": 16,
  "created_at": "2017-06-16T06:25:44.557Z",
  "updated_at": "2017-06-16T06:25:44.557Z",
  "return_resolution_name": "Refund",
  "fulfillment_lines": [
    {
      "id": 11120,
      "item_id": 1150,
      "item_variant_code": "white",
      "item_sku": "shirt_white",
      "item_name": "t-shirt",
      "quantity": "2.0",
      "unit_price_excluding_vat": "80.0",
      "unit_price_including_vat": "100.0",
      "amount_excluding_vat": "160.0",
      "amount_including_vat": "200.0",
      "vat_amount": "2.0",
      "vat_percent": "0.25",
      "currency_code": "DKK",
      "return_reason_name": "Item is not as expected",
      "return_comment": "The item was damaged upon arrival"
    }
  ]
}