Create a stock transfer

How to create a stock transfer via API

To create a new stock transfer, send a POST request to the /api/stock_transfers endpoint, passing the resource arguments in the request body.

Request

POST https://yourdomain.commercelayer.io/api/stock_transfers

Arguments

Body Parameter	Type	Required
type	string	Required
attributes.number	string	Optional, default to numeric id
attributes.sku_code	string	Optional
attributes.quantity	integer	Required
attributes.reference	string	Optional
attributes.reference_origin	string	Optional
attributes.metadata	object	Optional
relationships.sku	object	Required
relationships.origin_stock_location	object	Required
relationships.destination_stock_location	object	Required
relationships.shipment	object	Optional
relationships.line_item	object	Optional

Example

Request

The following request creates a new stock transfer:

curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/stock_transfers' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "stock_transfers",
    "attributes": {
      "quantity": 2
    },
    "relationships": {
      "sku": {
        "data": {
          "type": "skus",
          "id": "ABCRtyUpBa"
        }
      },
      "origin_stock_location": {
        "data": {
          "type": "stock_locations",
          "id": "BCDRtyUpBa"
        }
      },
      "destination_stock_location": {
        "data": {
          "type": "stock_locations",
          "id": "CDERtyUpBa"
        }
      }
    }
  }
}'

Response

On success, the API responds with a 201 Created status code, returning the created resource object:

{
  "data": {
    "id": "xYZkjABcde",
    "type": "stock_transfers",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde"
    },
    "attributes": {
      "number": "1234",
      "sku_code": "TSHIRTMM000000FFFFFFXLXX",
      "status": "draft",
      "quantity": 2,
      "on_hold_at": "2018-01-01T12:00:00.000Z",
      "picking_at": "2018-01-01T12:00:00.000Z",
      "in_transit_at": "2018-01-01T12:00:00.000Z",
      "completed_at": "2018-01-01T12:00:00.000Z",
      "cancelled_at": "2018-01-01T12:00:00.000Z",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "sku": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/relationships/sku",
          "related": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/sku"
        }
      },
      "origin_stock_location": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/relationships/origin_stock_location",
          "related": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/origin_stock_location"
        }
      },
      "destination_stock_location": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/relationships/destination_stock_location",
          "related": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/destination_stock_location"
        }
      },
      "shipment": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/relationships/shipment",
          "related": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/shipment"
        }
      },
      "line_item": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/relationships/line_item",
          "related": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/line_item"
        }
      },
      "stock_reservation": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/relationships/stock_reservation",
          "related": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/stock_reservation"
        }
      },
      "attachments": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/relationships/attachments",
          "related": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/attachments"
        }
      },
      "events": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/relationships/events",
          "related": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/events"
        }
      },
      "versions": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/relationships/versions",
          "related": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/versions"
        }
      }
    },
    "meta": {
      "mode": "test",
      "organization_id": "xRRkjDFafe",
      "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
    }
  }
}