Skip to content
ShipperOne Developer Portal

Ship fulfillment order

POST
/V1/fulfillmentOrder/ship

Report that items have been picked, packed, and dispatched with a carrier. Supports partial shipments with carrier and tracking information.

Request Body

Section titled “Request Body ”
object
shipment
required
object
order_id
required
string
items
required
Array<object>
object
item_id
required
integer
carrier_tracking_number
string
carrier_title
string
Example generated
{
  "shipment": {
    "order_id": "example",
    "items": [
      {
        "item_id": 1
      }
    ],
    "carrier_tracking_number": "example",
    "carrier_title": "example"
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

200 Success.

object
id
required
integer
fulfillment_order_number
required
string
sales_order_id
required
integer
sales_order_number
required
string
warehouse_code
required
string
customer_firstname
required
string
customer_lastname
required
string
customer_email
required
string
customer_is_guest
required
boolean
shipping_amount
number
shipping_amount_excl_tax
number
shipping_tax_amount
number
shipping_tax_rate
number
grand_total
number
grand_total_excl_tax
number
tax_amount
number
cod_amount
number
package_value
number
status
required
string
allocated_at
string
shipped_at
string
invoiced_at
string
created_at
required
string
updated_at
required
string
payment
required
object
method_code
required
string
method_name
required
string
shipping
required
object
method_code
required
string
method_name
required
string
internal_method_code
required
string
customer_note
string
pickup_point_delivery
object
location_id
required
string
location_name
required
string
billing_address
required
object
firstname
required
string
lastname
required
string
email
required
string
street
required
string
city
required
string
postcode
required
string
region
required
string
country_id
required
string
telephone
required
string
company
required
string
vat_id
required
string
shipping_address
required
object
firstname
required
string
lastname
required
string
email
required
string
street
required
string
city
required
string
postcode
required
string
region
required
string
country_id
required
string
telephone
required
string
company
required
string
vat_id
required
string
items
required
Array<object>
object
id
required
integer
status
required
string
warehouse_code
required
string
name
required
string
sku
required
string
qty
required
integer
price
number
price_excl_tax
number
tax_amount
number
tax_rate
number
total_price
number
total_price_excl_tax
number
total_tax_amount
number
Example generated
{
  "id": 1,
  "fulfillment_order_number": "example",
  "sales_order_id": 1,
  "sales_order_number": "example",
  "warehouse_code": "example",
  "customer_firstname": "example",
  "customer_lastname": "example",
  "customer_email": "example",
  "customer_is_guest": true,
  "shipping_amount": 1,
  "shipping_amount_excl_tax": 1,
  "shipping_tax_amount": 1,
  "shipping_tax_rate": 1,
  "grand_total": 1,
  "grand_total_excl_tax": 1,
  "tax_amount": 1,
  "cod_amount": 1,
  "package_value": 1,
  "status": "example",
  "allocated_at": "example",
  "shipped_at": "example",
  "invoiced_at": "example",
  "created_at": "example",
  "updated_at": "example",
  "payment": {
    "method_code": "example",
    "method_name": "example"
  },
  "shipping": {
    "method_code": "example",
    "method_name": "example",
    "internal_method_code": "example",
    "customer_note": "example",
    "pickup_point_delivery": {
      "location_id": "example",
      "location_name": "example"
    }
  },
  "billing_address": {
    "firstname": "example",
    "lastname": "example",
    "email": "example",
    "street": "example",
    "city": "example",
    "postcode": "example",
    "region": "example",
    "country_id": "example",
    "telephone": "example",
    "company": "example",
    "vat_id": "example"
  },
  "shipping_address": {
    "firstname": "example",
    "lastname": "example",
    "email": "example",
    "street": "example",
    "city": "example",
    "postcode": "example",
    "region": "example",
    "country_id": "example",
    "telephone": "example",
    "company": "example",
    "vat_id": "example"
  },
  "items": [
    {
      "id": 1,
      "status": "example",
      "warehouse_code": "example",
      "name": "example",
      "sku": "example",
      "qty": 1,
      "price": 1,
      "price_excl_tax": 1,
      "tax_amount": 1,
      "tax_rate": 1,
      "total_price": 1,
      "total_price_excl_tax": 1,
      "total_tax_amount": 1
    }
  ]
}

400

Section titled “400 ”

400 Bad Request

object
message
required

Error message

string
errors

Errors list

Array<object>

Error details

object
message

Error message

string
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
code

Error code

integer
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
trace

Stack trace

string
Example generated
{
  "message": "example",
  "errors": [
    {
      "message": "example",
      "parameters": [
        {
          "resources": "example",
          "fieldName": "example",
          "fieldValue": "example"
        }
      ]
    }
  ],
  "code": 1,
  "parameters": [
    {
      "resources": "example",
      "fieldName": "example",
      "fieldValue": "example"
    }
  ],
  "trace": "example"
}

401

Section titled “401 ”

401 Unauthorized

object
message
required

Error message

string
errors

Errors list

Array<object>

Error details

object
message

Error message

string
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
code

Error code

integer
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
trace

Stack trace

string
Example generated
{
  "message": "example",
  "errors": [
    {
      "message": "example",
      "parameters": [
        {
          "resources": "example",
          "fieldName": "example",
          "fieldValue": "example"
        }
      ]
    }
  ],
  "code": 1,
  "parameters": [
    {
      "resources": "example",
      "fieldName": "example",
      "fieldValue": "example"
    }
  ],
  "trace": "example"
}

500

Section titled “500 ”

Internal Server error

object
message
required

Error message

string
errors

Errors list

Array<object>

Error details

object
message

Error message

string
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
code

Error code

integer
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
trace

Stack trace

string
Example generated
{
  "message": "example",
  "errors": [
    {
      "message": "example",
      "parameters": [
        {
          "resources": "example",
          "fieldName": "example",
          "fieldValue": "example"
        }
      ]
    }
  ],
  "code": 1,
  "parameters": [
    {
      "resources": "example",
      "fieldName": "example",
      "fieldValue": "example"
    }
  ],
  "trace": "example"
}

default

Section titled “default ”

Unexpected error

object
message
required

Error message

string
errors

Errors list

Array<object>

Error details

object
message

Error message

string
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
code

Error code

integer
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
trace

Stack trace

string
Example generated
{
  "message": "example",
  "errors": [
    {
      "message": "example",
      "parameters": [
        {
          "resources": "example",
          "fieldName": "example",
          "fieldValue": "example"
        }
      ]
    }
  ],
  "code": 1,
  "parameters": [
    {
      "resources": "example",
      "fieldName": "example",
      "fieldValue": "example"
    }
  ],
  "trace": "example"
}