Skip to main content

Make a transfer by external identifier

POSThttps://carchost.fieldcontrol.com.br/storages-movements-v2/transfers

Transfers one or more products between two storages, identifying storages and products by their registered external.id. Each item generates a removal at the source and an entry at the destination. Requires the inventory control module.

Requires the X-Api-Key, User-Agent and Content-Type: application/json headers. Limit: 1 request per second (learn more).

Request​

Headers

User-Agentstringrequired

Identification of your application.

Example: MinhaIntegracao/1.0.

Request body

JSON, sent with the Content-Type: application/json header.

originStorageExternalIdstringrequired

External identifier (external.id) of the source storage.

destinationStorageExternalIdstringrequired

External identifier (external.id) of the destination storage.

notesstring

Note stored as the description of the movements.

itemslist of objectsrequired

Transferred products. The transfer is atomic; if one item fails, nothing is stored.

Fields of items
productExternalIdstringrequired

External identifier (external.id) of the product.

quantitynumberrequired

Transferred quantity. An integer for products measured in units; up to 3 decimal places for the others.

unitCostnumber

Unit cost reported to your source system. It does not change the product price in Field Control.

Responses

  • 201

    Transfer made.

  • 401

    API key missing (Missing API Key) or invalid (Invalid API Key). See Authentication.

  • 403

    Account blocked (Account blocked), expired (Account expired) or on a plan that does not allow integration (Account plan not allowed). See Authentication.

  • 422

    Invalid body (resourceValidationErr): missing storages or items (reason: missing field), storage or product not found by external identifier (reason: not found), product with no balance or with a balance lower than the quantity at the source (reason: Invalid removal), or quantity with too many decimal places. Account without the inventory control module: resourceNotAllowed.

  • 429

    Limit of 1 request per second exceeded. See Rate limit.

  • 500

    Unexpected server error.