Create entry

post

https://api.gobeeping.com/api/v1/client/entries

Authenticate with HTTP Basic using the client credentials. Entries are scoped to the authenticated user’s current team.

Creates an expected merchandise arrival in PENDIENTE status. team_id, user_id, reference and status are assigned by the server. Creation does not receive goods or increase stock.

Send at least one line and use each product_id only once. Product IDs must be available to the client. A 3PL team cannot own an entry.

The 201 response is the entry object directly, without a data envelope or lines. Use GET /api/v1/client/entries/{entry_id} to retrieve the saved lines.

Free-form metadata

The entry and its product lines may contain metadata: a free-form JSON object, array or null. For create and update requests, omitted or null metadata becomes an empty array. Responses include the saved metadata on the entry and each entry line. These dynamic values are shown in the JSON examples and intentionally left unexpanded in the visual schema.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

estimated_delivery_at

string | null

Estimated arrival date/time. Use YYYY-MM-DD HH:mm:ss. Dates are returned without an offset.

boxes_count

integer | null

≥ 1

description

string | null

tracking_codes

array of strings | null

Preferred tracking field. Codes are trimmed, empty codes removed and duplicates removed. When supplied as an array it takes precedence over tracking_code, including an empty array.

tracking_codes

tracking_code

string | null

deprecated

Legacy single tracking code. Used only if tracking_codes is not an array. Trimmed and truncated to 100 characters when stored. Prefer tracking_codes.

lines

array of objects

required

length ≥ 1

Complete list of expected products. Each product_id may occur only once.

lines*

product_id

integer

required

Existing product ID, available to the authenticated client. Obtain it from GET /api/v1/client/products.

qty_expected

integer

required

≥ 1

Expected number of units. Returned as expected_qty when reading an entry.

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Entry created. No data envelope and no lines in this response.

401Missing or invalid HTTP Basic credentials.

403A 3PL team cannot own merchandise.

404Product unavailable during creation.

409Duplicate product in lines. The whole operation is rolled back.

422Request validation failed. A missing/nonexistent entry_id or product_id may be rejected here before the domain lookup. Validation messages may vary.