Update Fulfillment Order Location

Updates the assigned location for a fulfillment order.

Use Cases

  • Reassigning to a location with available inventory
  • Optimizing fulfillment based on proximity to customer
  • Correcting initial allocation decisions

Request Requirements

  • location_id (required): The new location ID or location code

Location Resolution

The location is resolved in this order:

  1. First tries to find by partner_location_id
  2. If not found, tries to find by location_code for the merchant

Effects

When location is updated:

  • Fulfillment order's location_id is updated to the new location
  • Order status is recalculated
  • Webhooks are triggered

Inventory Impact

No direct inventory changes occur during location update. If you need to manage inventory reservations when changing locations, you should handle this separately through the Inventory API.

SecurityOAuth2-Production or OAuth2-Demo
Request
path Parameters
orderReference
required
string

The order reference (order_id or partner_order_reference based on the key parameter).

fulfillmentOrderId
required
string

The unique identifier of the fulfillment order.

query Parameters
key
string
Default: "order_id"

Specifies which reference type is being used for the order reference.

Enum: "order_id" "partner_order_reference"
header Parameters
x-api-key
required
string

Your Carriyo API key for authentication.

tenant-id
required
string

Your unique tenant identifier in Carriyo.

Content-Type
string
Default: application/json
Request Body schema: application/json
required
location_id
required
string

The new location ID for the fulfillment order.

Responses
200

Location updated successfully.

400

Cannot update location.

404

Order or fulfillment order not found.

patch/orders/{orderReference}/fulfillment-orders/{fulfillmentOrderId}/update-location
Request samples
application/json
{
  • "location_id": "string"
}
Response samples
application/json
{
  • "tenant": "string",
  • "order_id": "string",
  • "merchant": "string",
  • "partner_order_reference": "string",
  • "language": "string",
  • "order_date": "2019-08-24T14:15:22Z",
  • "sales_channel": "string",
  • "creation_source": {
    },
  • "update_source": {
    },
  • "carriyo_metadata": [
    ],
  • "status": "open",
  • "auto_allocation_failed": true,
  • "cancellation_reason": "CUSTOMER_CANCELLATION",
  • "shipping_address": {
    },
  • "billing_address": {
    },
  • "customer": {
    },
  • "payment": {
    },
  • "redacted": true,
  • "taxes_included": true,
  • "duties_included": true,
  • "discount_applications": [
    ],
  • "line_items": [
    ],
  • "fulfillment_orders": [
    ],
  • "shipping_lines": [
    ],
  • "error_details": [
    ],
  • "creation_date": "2019-08-24T14:15:22Z",
  • "update_date": "2019-08-24T14:15:22Z"
}