> ## Documentation Index > Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt > Use this file to discover all available pages before exploring further. # Count a delivery in > Records one delivery the destination warehouse counted in, as a stock receipt. Partial receipt is the normal case: ten left, eight arrived, two were crushed in transit. Quantities are this delivery's counts — a second box adds to the first rather than restating it. `quantity_accepted` lands on the destination's shelf; `quantity_rejected` is refused and recorded with a `rejection_reason` (`damaged`, `wrong_item`, `expired` or `other`), never stocked. A refused unit still arrived, so it counts toward the trip being over. Omit `items` to count in everything still outstanding, intact. The transfer stays `partially_received` while units are still on the road, settles in `received` once everything has arrived, and in `over_received` once more arrived than was shipped. **Required scope:** `write_stock` (for API-key authentication). ## OpenAPI ````yaml /api-reference/admin.yaml post /api/v3/admin/stock_transfers/{stock_transfer_id}/stock_receipts openapi: 3.0.3 info: title: Admin API contact: name: Spree Commerce url: https://spreecommerce.org email: hello@spreecommerce.org description: > Spree Admin API v3 - Administrative API for managing products, orders, and store settings. ## Authentication The Admin API requires a secret API key passed in the `x-spree-api-key` header. Secret API keys can be generated in the Spree admin dashboard. ## Response Format All responses are JSON. List endpoints return paginated responses with `data` and `meta` keys. Single resource endpoints return a flat JSON object. ## Resource IDs Every resource is identified by an opaque string ID (e.g. `prod_86Rf07xd4z`, `variant_k5nR8xLq`, `or_UkLWZg9DAJ`). Use these IDs everywhere — URL paths, request bodies, and Ransack filters all accept them directly. ## Error Handling Errors return a consistent format: ```json { "error": { "code": "validation_error", "message": "Validation failed", "details": { "name": ["can't be blank"] } } } ``` version: v3 servers: - url: http://{defaultHost} variables: defaultHost: default: localhost:3000 security: [] tags: - name: Authentication description: Admin user login, logout, token refresh, and current user profile - name: Allowed Origins description: CORS allowlist for storefront and admin client origins - name: API Keys description: Secret and publishable API keys - name: Categories description: >- Hierarchical product categories — tree management, repositioning, and product assignments - name: Channels description: >- Sales channels, product publication across channels, and per-channel order routing rules - name: Custom Fields description: >- Custom field definitions for products, variants, customers, and other resources - name: Customer Groups description: >- Customer groups for segmenting customers (e.g. wholesale, VIP) used by pricing and promotions - name: Customers description: Customer profiles, addresses, credit cards, and store credits - name: Email Templates description: >- Customer email templates, the email layout and shared partials: drafts, previews, publishing and history - name: Exports description: Async CSV exports of admin resources - name: Files description: Uploading the files that product media, imports, logos and documents use - name: Fulfillments description: Order fulfillments — shipments, fulfill, cancel, resume, split - name: Gift Cards description: Gift cards and gift card batches - name: Imports description: >- Async CSV imports of admin resources, with per-row status and failed-row retry - name: Markets description: >- Markets — geographic groupings of countries used for pricing, tax, and fulfillment rules - name: Option Types description: >- Option types and option values used to build product variants (e.g. Size, Color) - name: Orders description: Orders, order items, applied gift cards, and applied store credits - name: Payment Methods description: Configured payment providers and their available types - name: Payments description: Order payments — list, capture, void - name: Pricing description: >- Prices and price lists for currency-, market-, and customer-group-specific pricing - name: Products description: >- Products, taxons/categories, product custom field values, and bulk product operations - name: Policies description: The store's legal documents — terms of service, privacy, returns, shipping - name: Reasons description: >- Merchant-owned vocabularies for why a return, claim, refund, cancellation or tax exemption happened - name: Promotions description: Promotions, promotion rules, promotion actions, and coupon codes - name: Refunds description: Order refunds - name: Settings description: Store-level settings — store profile, tags, and configuration - name: Staff description: Admin users, roles, and invitations to the store - name: Stock Locations description: Warehouses and physical fulfillment locations - name: Store Credits description: Prepaid customer balances across all customers, and each balance's ledger - name: Variants description: >- Product variants — the individual SKUs (size/color combinations) sold under a product - name: Webhooks description: Webhook endpoints and webhook delivery history paths: /api/v3/admin/stock_transfers/{stock_transfer_id}/stock_receipts: parameters: - name: stock_transfer_id in: path required: true description: Stock transfer ID schema: type: string post: tags: - Stock Transfers summary: Count a delivery in description: |- Records one delivery the destination warehouse counted in, as a stock receipt. Partial receipt is the normal case: ten left, eight arrived, two were crushed in transit. Quantities are this delivery's counts — a second box adds to the first rather than restating it. `quantity_accepted` lands on the destination's shelf; `quantity_rejected` is refused and recorded with a `rejection_reason` (`damaged`, `wrong_item`, `expired` or `other`), never stocked. A refused unit still arrived, so it counts toward the trip being over. Omit `items` to count in everything still outstanding, intact. The transfer stays `partially_received` while units are still on the road, settles in `received` once everything has arrived, and in `over_received` once more arrived than was shipped. **Required scope:** `write_stock` (for API-key authentication). parameters: - name: x-spree-api-key in: header required: true schema: type: string - name: Authorization in: header required: true description: Bearer token for admin authentication schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/StockReceiptCreateParams' required: true responses: '201': description: delivery counted in content: application/json: example: id: sr_UkLWZg9DAJ number: SR1001 reference: null notes: null metadata: {} quantity_accepted_total: 8 quantity_rejected_total: 2 received_at: '2026-01-15T12:00:00.000Z' created_at: '2026-01-15T12:00:00.000Z' updated_at: '2026-01-15T12:00:00.000Z' receivable_type: stock_transfer receivable_id: st_UkLWZg9DAJ received_by_id: adm_UkLWZg9DAJ received_by_type: admin_user items_count: 1 schema: $ref: '#/components/schemas/StockReceipt' '422': description: transfer has not shipped yet content: application/json: example: error: code: processing_error message: Only a transfer in transit can be received schema: $ref: '#/components/schemas/ErrorResponse' security: - api_key: [] bearer_auth: [] x-codeSamples: - lang: javascript label: Spree Admin SDK source: >- import { createAdminClient } from '@spree/admin-sdk' const client = createAdminClient({ baseUrl: 'https://your-store.com', secretKey: 'sk_xxx', }) // Partial receipt is the normal case: ten left, eight arrived intact and two // crushed. Refused units are recorded, never stocked. const stockReceipt = await client.stockTransfers.stockReceipts.create('st_1234567890', { items: [ { id: 'sti_1234567890', quantity_accepted: 8, quantity_rejected: 2, rejection_reason: 'damaged', }, ], }) - lang: bash label: Spree CLI source: >- spree api post /stock_transfers/{stock_transfer_id}/stock_receipts -d '{"items":[{"id":"sti_1234567890","quantity_accepted":8,"quantity_rejected":2,"rejection_reason":"damaged"}]}' components: schemas: StockReceiptCreateParams: type: object properties: reference: type: string description: The supplier's delivery note, or the carrier's reference. example: DN-4471 nullable: true received_at: type: string format: date-time description: When the goods were counted in. Defaults to now. nullable: true notes: type: string nullable: true items: type: array items: $ref: '#/components/schemas/StockReceiptItemParams' description: >- Omit to book in everything still outstanding, intact. Naming lines, even none, records exactly what the dock counted: `quantity_accepted` reaches the shelf; `quantity_rejected` is refused, recorded with a `rejection_reason` and never stocked. StockReceipt: type: object properties: id: type: string number: type: string reference: type: string nullable: true notes: type: string nullable: true metadata: type: object quantity_accepted_total: type: number quantity_rejected_total: type: number received_at: type: string created_at: type: string updated_at: type: string receivable_type: type: string enum: - purchase_order - stock_transfer receivable_id: type: string received_by_id: type: string nullable: true received_by_type: anyOf: - type: string enum: - admin_user - api_key - type: string nullable: true description: The values listed are the built-in ones; extensions may add more. received_by: $ref: '#/components/schemas/Actor' items_count: type: number items: type: array items: $ref: '#/components/schemas/StockReceiptItem' required: - id - number - reference - notes - metadata - quantity_accepted_total - quantity_rejected_total - received_at - created_at - updated_at - receivable_type - receivable_id - received_by_id - received_by_type - items_count x-typelizer: true ErrorResponse: type: object properties: error: type: object properties: code: type: string example: record_not_found message: type: string example: Record not found details: type: object description: Field-specific validation errors nullable: true example: name: - is too short - is required email: - is invalid required: - code - message required: - error example: error: code: validation_error message: Validation failed details: name: - is too short email: - is invalid StockReceiptItemParams: type: object properties: id: type: string description: The purchase order or transfer line. quantity_accepted: type: integer example: 58 quantity_rejected: type: integer example: 2 rejection_reason: type: string enum: - damaged - wrong_item - expired - other example: damaged nullable: true notes: type: string nullable: true required: - id Actor: type: object properties: id: type: string type: anyOf: - type: string enum: - admin_user - api_key - type: string description: The values listed are the built-in ones; extensions may add more. label: type: string nullable: true required: - id - type - label x-typelizer: true StockReceiptItem: type: object properties: id: type: string quantity_accepted: type: number quantity_rejected: type: number rejection_reason: type: string nullable: true enum: - damaged - wrong_item - expired - other notes: type: string nullable: true line_type: type: string enum: - purchase_order_item - stock_transfer_item line_id: type: string nullable: true variant_id: type: string nullable: true product_id: type: string nullable: true variant_name: type: string nullable: true variant_sku: type: string nullable: true thumbnail_url: type: string nullable: true required: - id - quantity_accepted - quantity_rejected - rejection_reason - notes - line_type - line_id - variant_id - product_id - variant_name - variant_sku - thumbnail_url x-typelizer: true securitySchemes: api_key: type: apiKey name: x-spree-api-key in: header description: Secret API key for admin access bearer_auth: type: http scheme: bearer bearerFormat: JWT description: JWT token for admin user authentication ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.