> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. # Create shipment > Create a new shipment with a tracking code for a specific payment within a company. Required permissions: - `shipment:create` - `payment:basic:read` ## OpenAPI ````yaml /openapi/api-v1-stable.json post /shipments openapi: 3.1.0 info: description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ title: Whop API version: 1.0.0 x-api-version-date: 2026-07-08-1 servers: - description: Production Whop API url: https://api.whop.com/api/v1 - description: Sandbox Whop API url: https://sandbox-api.whop.com/api/v1 security: [] tags: - description: Products name: Products - description: Payments name: Payments - description: Refunds name: Refunds - description: Disputes name: Disputes - description: Dispute alerts name: Dispute alerts - description: Resolution center cases name: Resolution center cases - description: Checkout configurations name: Checkout configurations - description: Setup intents name: Setup intents - description: Payment methods name: Payment methods - description: Invoices name: Invoices - description: Promo codes name: Promo codes - description: Card transactions name: Card transactions - description: Ledger accounts name: Ledger accounts - description: Withdrawals name: Withdrawals - description: Payout methods name: Payout methods - description: Verifications name: Verifications - description: Identity profiles name: Identity profiles - description: Payout accounts name: Payout accounts - description: Topups name: Topups - description: Companies name: Companies - description: Authorized users name: Authorized users - description: Fee markups name: Fee markups - description: Members name: Members - description: Memberships name: Memberships - description: Leads name: Leads - description: Entries name: Entries - description: Shipments name: Shipments - description: Reviews name: Reviews - description: Company token transactions name: Company token transactions - description: Affiliates name: Affiliates - description: Experiences name: Experiences - description: Forums name: Forums - description: Forum posts name: Forum posts - description: Chat channels name: Chat channels - description: Support channels name: Support channels - description: Messages name: Messages - description: Reactions name: Reactions - description: Dm members name: Dm members - description: Dm channels name: Dm channels - description: Notifications name: Notifications - description: Courses name: Courses - description: Course chapters name: Course chapters - description: Course lessons name: Course lessons - description: Course students name: Course students - description: Course lesson interactions name: Course lesson interactions - description: Apps name: Apps - description: Webhooks name: Webhooks - description: App builds name: App builds - description: Access tokens name: Access tokens - description: Account links name: Account links - description: Files name: Files - description: Ai chats name: Ai chats - description: Bounties name: Bounties - description: Stats name: Stats - description: Conversions name: Conversions - description: Ad reports name: Ad reports paths: /shipments: post: tags: - Shipments summary: Create shipment description: >- Create a new shipment with a tracking code for a specific payment within a company. Required permissions: - `shipment:create` - `payment:basic:read` operationId: createShipment parameters: [] requestBody: content: application/json: schema: description: Parameters for CreateShipment properties: company_id: description: >- The unique identifier of the company to create the shipment for, starting with 'biz_'. example: biz_xxxxxxxxxxxxxx type: string payment_id: description: >- The unique identifier of the payment to associate the shipment with. example: pay_xxxxxxxxxxxxxx type: string tracking_code: description: >- The carrier tracking code for the shipment, such as a USPS, UPS, or FedEx tracking number. type: string required: - company_id - payment_id - tracking_code type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Shipment' description: A successful response '400': content: application/json: example: error: code: parameter_missing message: 'Missing required parameter: amount.' param: amount type: invalid_request_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Bad request '401': content: application/json: example: error: message: Invalid or missing API key type: unauthorized schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Unauthorized '403': content: application/json: example: error: message: You do not have permission to access this resource type: forbidden schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Forbidden '404': content: application/json: example: error: message: Resource not found type: not_found schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Not found '422': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Verification required '429': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Too many requests '500': content: application/json: example: error: message: An unexpected error occurred type: internal_server_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Internal server error security: - bearerAuth: - shipment:create - payment:basic:read components: schemas: Shipment: description: >- A physical shipment associated with a payment, including carrier details and tracking information. properties: carrier: $ref: '#/components/schemas/ShipmentCarriers' description: The shipping carrier responsible for delivering this shipment. created_at: description: The datetime the shipment was created. example: '2023-12-01T05:00:00.401Z' format: date-time type: string delivery_estimate: description: >- The estimated delivery date for this shipment. Null if the carrier has not provided an estimate. example: '2023-12-01T05:00:00.401Z' format: date-time type: - string - 'null' id: description: The unique identifier for the shipment. example: ship_xxxxxxxxxxxxx type: string payment: description: >- The payment associated with this shipment. Null if the payment has been deleted or is inaccessible. properties: id: description: The unique identifier for the payment. example: pay_xxxxxxxxxxxxxx type: string required: - id type: - object - 'null' service: description: >- The shipping service level used for this shipment. Null if the carrier does not specify a service tier. example: Priority type: - string - 'null' status: $ref: '#/components/schemas/ShipmentStatuses' description: The current delivery status of this shipment. substatus: description: >- A more granular status providing additional detail about the shipment's current state. Null if no substatus applies. oneOf: - $ref: '#/components/schemas/ShipmentSubstatuses' - type: 'null' tracking_code: description: >- The carrier-assigned tracking number used to look up shipment progress. example: '9400111899223456789012' type: string updated_at: description: The datetime the shipment was last updated. example: '2023-12-01T05:00:00.401Z' format: date-time type: string required: - id - created_at - status - substatus - tracking_code - updated_at - carrier - service - delivery_estimate - payment type: object ShipmentCarriers: description: The carrier of a shipment enum: - accurate - amazon_mws - amazon_shipping - apc - asendia_usa - australia_post - axlehire_v3 - better_trucks - canada_post - canpar - columbus_last_mile - chronopost - cloud_sort - courier_express - couriers_please - cs_logistics - dai_post - deutsche_post_uk - deutsche_post - dhl_ecommerce_asia - dhl_ecs - dhl_express - dhl_paket - door_dash - dpd_nl - dpd_uk - dpd - epost_global - estafeta - evri - fastway - fedex_cross_border - fedex_default - fedex_mailview - fedex_smartpost - fedex - first_choice - first_mile - flexport - gio - gio_express - gso - hailify - henry - interlink_express - jet - kuroneko_yamato - la_post - lasership_v2 - loomis_express - lso - ontrac - optima - osm_worldwide - parcelforce - parcll - passport_global - post_nl - purolator - quick - royal_mail - omni_parcel - sendle - sf_express - smart_kargo - sonic - spee_dee - swyft - tforce - uds - ups_iparcel - ups_mail_innovations - ups - usps - veho - yanwen type: string ShipmentStatuses: description: The status of a shipment enum: - unknown - pre_transit - in_transit - out_for_delivery - delivered - available_for_pickup - return_to_sender - failure - cancelled - error type: string ShipmentSubstatuses: description: The substatus of a shipment enum: - address_correction - arrived_at_destination - arrived_at_facility - arrived_at_pickup_location - awaiting_information - substatus_cancelled - damaged - delayed - delivery_exception - departed_facility - departed_origin_facility - expired - substatus_failure - held - substatus_in_transit - label_created - lost - missorted - substatus_out_for_delivery - received_at_destination_facility - received_at_origin_facility - refused - return - status_update - transferred_to_destination_carrier - transit_exception - substatus_unknown - weather_delay type: string securitySchemes: bearerAuth: bearerFormat: auth-scheme description: >- A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like `Bearer ***************************` scheme: bearer type: http ````