COcommercelayer
stock_transfers

Update a stock transfer

Changed on

Update a stock transfer

patch/stock_transfers/{stockTransferId}

Request

  • Base URL
    https://{your_organization_slug}.commercelayer.io/api
  • URL
    https://{your_organization_slug}.commercelayer.io/api/stock_transfers/{stockTransferId}
  • Auth
    HTTP bearer

Path parameters

stockTransferIdstring required

The resource's id

Request body

Example request

{
  "data": {
    "id": "XAyRWNUzyN",
    "attributes": {
      "number": "1234",
      "sku_code": "TSHIRTMM000000FFFFFFXLXX",
      "quantity": 2,
      "_upcoming": true,
      "_on_hold": true,
      "_picking": true,
      "_in_transit": true,
      "_complete": true,
      "_cancel": true,
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "sku": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      },
      "origin_stock_location": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      },
      "destination_stock_location": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      },
      "shipment": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      },
      "line_item": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      }
    }
  }
}

Response

The updated stock transfer object

Changes

  • 859097ed3fe6Revision changes
    • breaking

      added the new required request property ///

    • breaking

      added the new required request property ///

    • breaking

      added the new required request property ///

    • breaking

      request property / was restricted to a list of enum values

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      the request property // became nullable

    • info

      the request property // became nullable

    • info

      the request property // became nullable

    • info

      the request property // became nullable

    • info

      the request property default value stock_transfers was removed

    • info

      added the new stock_transfers enum value to the request property /

    • info

      added the media type application/vnd.api+json for the response with the status