> ## Documentation Index > Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a new package on an order > Creates a new shipment package for an order, optionally seeding it with line items from the order. Specify the `order_id`, box dimensions and weight, and carrier preferences. The package starts in `status: draft`; call `POST /packages/{id}/print-label` to purchase a shipping label. Requires `fulfillment:write` scope. **Revision acknowledgment gate (HTTP 409 `revision_unacknowledged`).** If the parent order was revised after the customer received their copy and the customer has not yet acknowledged the new total, this endpoint returns HTTP 409 with `code: revision_unacknowledged`. Lift the gate via `POST /v1/orders/{id}/customer-acknowledge-revision`, or bypass with `?override=true` / `{"skip_revision_ack": true}` in the body (requires `orders.revision_override` permission). ## OpenAPI ````yaml /openapi.yaml post /packages openapi: 3.1.0 info: title: Arcus ERP Public API version: 1.0.0 description: > Arcus ERP public REST API. Designed for external integrations and data migration. **Authentication.** Bearer token (API key) via the `Authorization` header. Format: `Authorization: Bearer ark_live_ent__` (or `ark_test_*` for sandbox). API keys are issued per-entity in **Settings > Developers > API Keys**. **Entity scoping.** The entity is encoded in the API key prefix; routes are flat (e.g. `/v1/accounts`, `/v1/orders`, `/v1/products`). A small set of platform endpoints (migration, reconciliation, events, webhook endpoints, API keys) use the `/v1/entities/{entity_id}/...` form -- those are noted in their tags. **Key capabilities.** - Related-resource hydration via `?expand[]=` (see `x-arcus-expand` on each resource). - Cursor-based pagination (`starting_after` / `ending_before` / `limit`). - Idempotency via the `Idempotency-Key` header. - Webhook events for asynchronous notification. - Conditional requests / ETag for cache validation. servers: - url: https://api.arcuserp.com/v1 description: Arcus ERP API (accepts both live `ark_live_*` and test `ark_test_*` keys) - url: https://dev-api.arcuserp.com/v1 description: >- Dev sandbox API (test-only data, accepts `ark_test_*` keys against dev RDS) security: [] paths: /packages: post: tags: - Fulfillment summary: Create a new package on an order description: > Creates a new shipment package for an order, optionally seeding it with line items from the order. Specify the `order_id`, box dimensions and weight, and carrier preferences. The package starts in `status: draft`; call `POST /packages/{id}/print-label` to purchase a shipping label. Requires `fulfillment:write` scope. **Revision acknowledgment gate (HTTP 409 `revision_unacknowledged`).** If the parent order was revised after the customer received their copy and the customer has not yet acknowledged the new total, this endpoint returns HTTP 409 with `code: revision_unacknowledged`. Lift the gate via `POST /v1/orders/{id}/customer-acknowledge-revision`, or bypass with `?override=true` / `{"skip_revision_ack": true}` in the body (requires `orders.revision_override` permission). operationId: createPackage parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: type: object required: - order_id properties: order_id: type: string format: uuid description: >- Required. Parent sales order UUID. Must be a confirmed sales order. box_product_id: type: string format: uuid description: >- Product record for the box. Drives dimensions + PackPilot category matching. length: type: number description: Length in inches. width: type: number description: Width in inches. height: type: number description: Height in inches. weight: type: number description: Weight in lbs. notes: type: string metadata: type: object carrier_service: type: string description: >- Compound carrier+service string (e.g. 'ups_ground', 'fedex_priority_overnight'). Mapped to carrier+service fields automatically. Alternative to passing carrier+service separately. example: ups_ground carrier: type: string description: >- Carrier code (e.g. 'ups', 'fedex', 'usps'). Use carrier_service for combined form. service: type: string description: >- Service level (e.g. 'ground', 'priority_overnight'). Use carrier_service for combined form. items: type: array description: >- Inline line items to add to the package. Added atomically with the package creation. items: type: object required: - quantity properties: order_item_id: type: string format: uuid description: >- Required when adding a specific order line. Validates qty against remaining unpackaged quantity. product_id: type: string format: uuid description: Required if order_item_id not provided. quantity: type: integer minimum: 1 description: >- Quantity to add. Must not exceed remaining unpackaged quantity on the order_item. serial_numbers: type: array items: type: string description: >- Serial numbers for serialized products. Each serial must be unique and in 'allocated' status. buy_label: type: boolean default: false description: >- If true, purchase a Shippo label immediately after package creation. Requires rate_object_id. If label purchase fails, the package is still created and returned in the error body. rate_object_id: type: string description: >- Required with buy_label=true. Shippo rate object ID from GET /v1/packages/:id/rates. fulfill_after_label: type: boolean default: false description: >- If true, fulfill the package immediately after label purchase. Posts GL fulfillment entries (DR COGS/CR Inventory, DR AR/CR Revenue), decrements inventory, queues shipment notification. Only fires when buy_label=true AND label purchase succeeds. label_file_type: type: string enum: - PDF - PNG - ZPLII default: PDF description: Label format for Shippo. PDF is the default. examples: full_atomic_create: summary: Package + items + label + fulfill in one POST value: order_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 carrier_service: ups_ground items: - order_item_id: 11111111-2222-3333-4444-555555555555 quantity: 2 serial_numbers: - SN001 - SN002 - order_item_id: 22222222-3333-4444-5555-666666666666 quantity: 1 buy_label: true rate_object_id: SHIPPO_RATE_OBJECT_ID fulfill_after_label: true package_only: summary: Package with items only (no label) value: order_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 items: - order_item_id: 11111111-2222-3333-4444-555555555555 quantity: 3 responses: '201': description: >- Created package (hydrated with items, and label/fulfillment data if inline operations ran) content: application/json: schema: $ref: '#/components/schemas/Package' '400': $ref: '#/components/responses/Error' '401': $ref: '#/components/responses/Error' '403': $ref: '#/components/responses/Error' '404': $ref: '#/components/responses/Error' '409': description: > Revision not yet acknowledged by customer (`code: revision_unacknowledged`). The parent order was revised after the customer received their copy. Use `POST /v1/orders/{id}/customer-acknowledge-revision` to record the customer's acknowledgment, or pass `skip_revision_ack: true` / `?override=true` with the `orders.revision_override` permission. content: application/json: schema: $ref: '#/components/schemas/Error' '422': $ref: '#/components/responses/Error' security: - ApiKeyAuth: [] components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: false description: | Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours. schema: type: string maxLength: 255 schemas: Package: type: object description: | A shipment / box created during fulfillment. One package contains many package items (line item splits) and at most one shipment label. properties: id: type: string format: uuid object: type: string enum: - package entity_id: type: string format: uuid readOnly: true order_id: type: string format: uuid package_number: type: string readOnly: true description: Sequential per entity. status: type: string enum: - packing - packed - labeled - shipped - delivered - returned - void readOnly: true weight_lb: type: number nullable: true length_in: type: number nullable: true width_in: type: number nullable: true height_in: type: number nullable: true carrier: type: string nullable: true description: e.g. ups, usps, fedex, dhl. service_level: type: string nullable: true description: e.g. ground, priority, 2day. tracking_number: type: string nullable: true tracking_url: type: string nullable: true ship_cost: type: number nullable: true billed_ship_cost: type: number nullable: true description: Cost billed to customer (vs purchased cost). location_id: type: string format: uuid nullable: true insurance_amount_override: type: number nullable: true description: > Manual override of the auto-computed Shippo-insurance declared value. When set, overrides the value derived from products flagged apply_freight_insurance. insurance: type: object nullable: true readOnly: true description: > Auto-insurance summary. `null` when no package item opts in and there is no override / entity threshold. `bought: true` after a label has been purchased (amount = the value actually insured at Shippo); `bought: false` projects what the next label purchase will insure. properties: active: type: boolean bought: type: boolean amount: type: number description: Insured declared value (USD). currency: type: string fee_estimate: type: number description: ~1.5% of declared value; the exact fee is in the rate. provider: type: string nullable: true description: UPS | USPS | FEDEX | DHL once the carrier is chosen. covered_items: type: array items: type: string covered_item_count: type: integer source: type: string enum: - product_toggle - entity_threshold - manual_override shipped_at: type: string format: date-time nullable: true readOnly: true delivered_at: type: string format: date-time nullable: true readOnly: true metadata: type: object nullable: true created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true Error: description: | Alias for ErrorEnvelope. Canonical error response shape used by all API endpoints. Refer to ErrorEnvelope for the full field definition. allOf: - $ref: '#/components/schemas/ErrorEnvelope' ErrorEnvelope: type: object description: | Canonical error response envelope. All API errors use this shape. required: - error - code properties: error: type: string description: Machine-readable error key example: not_found code: type: string description: Machine-readable error code (often same as error) example: not_found type: type: string enum: - validation_error - permission_error - not_found - conflict - rate_limit - internal - expand_error - not_implemented example: not_found hint: type: string description: Human-readable one-sentence explanation (English) example: >- The requested order does not exist or does not belong to this entity. param: type: string description: The parameter that caused the error, if applicable example: expand[0] required: type: string description: The scope required (only on insufficient_scope errors) example: accounts:read request_id: type: string description: >- Unique request ID for support tracing (maps to CloudWatch log stream) example: req_abc123 responses: Error: description: Error response (400/401/403/404/409/422/429/500) content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: ApiKeyAuth: type: http scheme: bearer description: | API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent__ Test keys use ark_test_ent__. Both are issued per entity via Settings > Developers > API Keys. ````