generated: '2026-10-12'
method: derived
generator: derive-vocabulary.py
source:
- openapi/aftership-address-api-openapi.yml
- openapi/aftership-address-validations-beta-api-openapi.yml
- openapi/aftership-cancel-labels-api-openapi.yml
- openapi/aftership-cancel-pickups-api-openapi.yml
- openapi/aftership-claim-items-api-openapi.yml
vocabulary:
  name: AfterShip Domain Vocabulary
  description: 'Terms declared by AfterShip''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions.
    Derived, not authored.'
  version: '2026-10-12'
  terms:
  - term: Claim Items
    definition: Public endpoints for updating item-level claim data.
    tags:
    - Resource Group
    source: openapi/aftership-claim-items-api-openapi.yml
  - term: Claim Shipments
    definition: Public endpoints for creating and polling claim shipment resources.
    tags:
    - Resource Group
    source: openapi/aftership-claim-shipments-api-openapi.yml
  - term: Item Tags
    definition: Public endpoints for reading item tags that can be applied to claim items.
    tags:
    - Resource Group
    source: openapi/aftership-item-tags-api-openapi.yml
  - term: Warranty Registrations
    definition: Public endpoints for querying and correcting warranty registration data.
    tags:
    - Resource Group
    source: openapi/aftership-warranty-registrations-api-openapi.yml
  - term: Address
    definition: Common address object.
    tags:
    - Object
    source: openapi/aftership-address-api-openapi.yml#/components/schemas/Address
  - term: Meta
    definition: Meta data object.
    tags:
    - Object
    source: openapi/aftership-address-api-openapi.yml#/components/schemas/Meta
  - term: Error
    definition: Each error object contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error
      location. The "info" is a human-readable description of the error.
    tags:
    - Object
    source: openapi/aftership-address-api-openapi.yml#/components/schemas/Error
  - term: AddressValidation
    definition: The Address Validation object is used to provide information about an address, including the recommended address if available.
      Production and sandbox APIs support `USA` addresses by default, and you can contact our support team to enable `AUS, BEL, DNK, and DEU`
      in our sandbox API for testing as well.
    tags:
    - Object
    source: openapi/aftership-address-validations-beta-api-openapi.yml#/components/schemas/Address_validation.v3
  - term: Address
    definition: 'Address object: the description of address information'
    tags:
    - Object
    source: openapi/aftership-address-validations-beta-api-openapi.yml#/components/schemas/Address.v3
  - term: Meta
    definition: Meta data object.
    tags:
    - Object
    source: openapi/aftership-address-validations-beta-api-openapi.yml#/components/schemas/Meta.v3
  - term: Error
    definition: Each error object contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error
      location. The "info" is a human-readable description of the error.
    tags:
    - Object
    source: openapi/aftership-address-validations-beta-api-openapi.yml#/components/schemas/Error.v3
  - term: Reference
    definition: 'Reference object: the description of reference information'
    tags:
    - Object
    source: openapi/aftership-cancel-labels-api-openapi.yml#/components/schemas/Reference.v3
  - term: CancelLabel
    definition: 'Cancel Label object: the description of cancel label object'
    tags:
    - Object
    source: openapi/aftership-cancel-labels-api-openapi.yml#/components/schemas/Cancel_label.v3
  - term: CancelPickup
    definition: 'Cancel Pickup object: the description of cancel pickup object'
    tags:
    - Object
    source: openapi/aftership-cancel-pickups-api-openapi.yml#/components/schemas/Cancel_pickup.v3
  - term: ItemTag
    definition: A merchant-defined tag that can be added to claim items.
    tags:
    - Object
    source: openapi/aftership-claim-items-api-openapi.yml#/components/schemas/ItemTag
  - term: Meta
    definition: Meta data object.
    tags:
    - Object
    source: openapi/aftership-claim-items-api-openapi.yml#/components/schemas/Meta_20000
  - term: Money
    definition: The store credit value.
    tags:
    - Object
    source: openapi/aftership-claim-items-api-openapi.yml#/components/schemas/Money
  - term: ClaimItem
    definition: A claim item resource.
    tags:
    - Object
    source: openapi/aftership-claim-items-api-openapi.yml#/components/schemas/Claim_item
  - term: ClaimShipment
    definition: A shipment in the shared claim resource. API-only async label generation fields are documented on shipment operation responses,
      not in this shared resource.
    tags:
    - Object
    source: openapi/aftership-claim-shipments-api-openapi.yml#/components/schemas/Claim_shipment
  - term: Error
    definition: Each error object contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error
      location. The "info" is a human-readable description of the error.
    tags:
    - Object
    source: openapi/aftership-claims-api-openapi.yml#/components/schemas/Error.v1
  - term: Meta
    definition: Meta data object.
    tags:
    - Object
    source: openapi/aftership-claims-api-openapi.yml#/components/schemas/Meta.v1
  - term: Amount
    definition: 'Object declared by the contract with fields: amount, currency.'
    tags:
    - Object
    source: openapi/aftership-claims-api-openapi.yml#/components/schemas/Amount.v1
  - term: Pagination
    definition: Pagination data
    tags:
    - Object
    source: openapi/aftership-claims-api-openapi.yml#/components/schemas/Pagination.v1
  - term: Order Item
    definition: 'Object declared by the contract with fields: source_id, title, quantity, unit_insured_amount, sku, image_urls.'
    tags:
    - Object
    source: openapi/aftership-claims-api-openapi.yml#/components/schemas/Order_item.v1
  - term: Claim
    definition: 'Object declared by the contract with fields: id, number, coverage_id, status, resolve_status, resolved_resolution_method, resolved_resolution_detail,
      customer_resolution_method, customer_resolution_detail, created_at, updated_at, issue_type. (10 more)'
    tags:
    - Object
    source: openapi/aftership-claims-api-openapi.yml#/components/schemas/Claim.v1
  - term: Claim
    definition: A claim resource.
    tags:
    - Object
    source: openapi/aftership-claims-api-openapi.yml#/components/schemas/Claim
  - term: credential_field
    definition: 'Object declared by the contract with fields: name, type, required.'
    tags:
    - Object
    source: openapi/aftership-courier-api-openapi.yml#/components/schemas/Credential_field
  - term: Courier
    definition: Courier object [url](../../docs/enum/additional_tracking_fields.md)[url](../../docs/enum/delivery_sub_statuses.md)[url](../../docs/enum/delivery_statuses.md)[url](../../docs/enum/slug_groups.md)[url](../../model/resource/tracking.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fie
    tags:
    - Object
    source: openapi/aftership-courier-api-openapi.yml#/components/schemas/Courier
  - term: Courier response
    definition: Model of all couriers endpoint response
    tags:
    - Object
    source: openapi/aftership-courier-api-openapi.yml#/components/schemas/Courier_response.v1
  - term: additional_fields
    definition: All available additional fields[url](../../docs/enum/additional_tracking_fields.md)[url](../../docs/enum/delivery_sub_statuses.md)[url](../../docs/enum/delivery_statuses.md)[url](../../docs/enum/slug_groups.md)[url](../../model/resource/tracking.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enu
    tags:
    - Enumeration
    source: openapi/aftership-courier-api-openapi.yml#/components/schemas/Additional_fields.v1
  - term: courier_connection
    definition: This model represents user-created courier connection details. AfterShip will use this information to retrieve tracking updates
      from carriers based on the provided tracking numbers.
    tags:
    - Object
    source: openapi/aftership-courier-connection-api-openapi.yml#/components/schemas/Courier_connection
  - term: Courier connection response for get courier connections
    definition: Courier connection response for getting courier connections
    tags:
    - Object
    source: openapi/aftership-courier-connection-api-openapi.yml#/components/schemas/Courier_connection_response_get_multiple
  - term: Courier
    definition: 'Courier object: the description of supported couriers Courier slug, please check [supported couriers](https://www.aftership.com/docs/shipping/others/supported-couriers)
      for details'
    tags:
    - Object
    source: openapi/aftership-couriers-api-openapi.yml#/components/schemas/Courier.v3
  - term: Coverage
    definition: 'Object declared by the contract with fields: id, source_id, policy_number, status, policy_detail_url, premium, effective_time,
      expiration_time, updated_at, created_at, items, shipping_address. (5 more)'
    tags:
    - Object
    source: openapi/aftership-coverages-api-openapi.yml#/components/schemas/Coverage.v1
  - term: Address
    definition: 'Object declared by the contract with fields: street_1, street_2, street_3, postal_code, city, state, country_region, phone, email,
      first_name, last_name.'
    tags:
    - Object
    source: openapi/aftership-coverages-api-openapi.yml#/components/schemas/Address.v1
  - term: Tracking
    definition: tracking information about package.
    tags:
    - Object
    source: openapi/aftership-coverages-api-openapi.yml#/components/schemas/Tracking.v1
  - term: PredictTag
    definition: Predict product tag object.
    tags:
    - Object
    source: openapi/aftership-discoveries-api-openapi.yml#/components/schemas/Predict_tags
  - term: TaggingProduct
    definition: Partial Commerce Product object to be tagged.
    tags:
    - Object
    source: openapi/aftership-discoveries-api-openapi.yml#/components/schemas/Tagging_product
  - term: PartialProduct
    definition: Partial Commerce Product object.
    tags:
    - Object
    source: openapi/aftership-discoveries-api-openapi.yml#/components/schemas/Partial_product
  - term: SearchRequest
    definition: 'Object declared by the contract with fields: session_id, query, image_url, image_base64, include_filters, exclude_filters, faceting,
      sort, page, limit.'
    tags:
    - Object
    source: openapi/aftership-discoveries-api-openapi.yml#/components/schemas/Search_request
  - term: RecommendType
    definition: Default algorithm configuration type.
    tags:
    - Enumeration
    source: openapi/aftership-discoveries-api-openapi.yml#/components/schemas/Recommend_type
  - term: TaggingResponse
    definition: 'Object declared by the contract with fields: meta, data.'
    tags:
    - Object
    source: openapi/aftership-discoveries-api-openapi.yml#/components/schemas/Tagging_response
  - term: TaggingPlatform
    definition: Target e-commerce platform. The classification system of the platform will be used for prediction.
    tags:
    - Enumeration
    source: openapi/aftership-discoveries-api-openapi.yml#/components/schemas/Tagging_platform
  - term: TaggingRequest
    definition: 'Object declared by the contract with fields: product, platform.'
    tags:
    - Object
    source: openapi/aftership-discoveries-api-openapi.yml#/components/schemas/Tagging_request
  - term: SuggestResponse
    definition: 'Object declared by the contract with fields: meta, data.'
    tags:
    - Object
    source: openapi/aftership-discoveries-api-openapi.yml#/components/schemas/Suggest_response
  - term: PredictCategory
    definition: Predict product category object.
    tags:
    - Object
    source: openapi/aftership-discoveries-api-openapi.yml#/components/schemas/Predict_categories
  - term: SuggestRequest
    definition: 'Object declared by the contract with fields: query, session_id, limit.'
    tags:
    - Object
    source: openapi/aftership-discoveries-api-openapi.yml#/components/schemas/Suggest_request
  - term: SearchResponse
    definition: 'Object declared by the contract with fields: meta, data.'
    tags:
    - Object
    source: openapi/aftership-discoveries-api-openapi.yml#/components/schemas/Search_response
  - term: RecommendRequest
    definition: 'Object declared by the contract with fields: type, session_id, include_filters, exclude_filters, limit, products.'
    tags:
    - Object
    source: openapi/aftership-discoveries-api-openapi.yml#/components/schemas/Recommend_request
  - term: RecommendResponse
    definition: 'Object declared by the contract with fields: meta, data.'
    tags:
    - Object
    source: openapi/aftership-discoveries-api-openapi.yml#/components/schemas/Recommend_response
  - term: TrackingV2
    definition: Tracking information parsed from the email
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Tracking.v2
  - term: ShippingMethodV2
    definition: The shipping method.
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Shipping_method.v2
  - term: OpeningHoursV2
    definition: Opening hours information of the pickup location.
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Opening_hours.v2
  - term: AddressV2
    definition: 'Object declared by the contract with fields: raw_location, phone, postal_code, city, state, country_region.'
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Address.v2
  - term: EstimatedDeliveryDate
    definition: It refers to the estimated delivery date parsed from the email. The maximum will be null if the estimated delivery date does not
      have a valid time range.
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Estimated_delivery_date.v1
  - term: Attachment
    definition: 'Object declared by the contract with fields: filename, content_type, data.'
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Attachment.v1
  - term: Money
    definition: The money object is used to represent the currency amount. In some cases, if it cannot parse the currency from the symbol, the
      currency will be null while the symbol will have a value.
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Money.v1
  - term: Store
    definition: Store object
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Store.v1
  - term: OpeningHourPeriodV2
    definition: The `OpeningHourPeriod` model provides detailed information about a location's operating hours for a specific day. It includes
      the start and end times, and indicates whether the location is open on that particular day. When `open` is `true` and both `from` and `to`
      are `null`, it indicates the location operates 24 hours on that day.
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Opening_hour_period.v2
  - term: PickupAddressV2
    definition: Structured pickup address, enriched from `raw_address`.
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Pickup_address.v2
  - term: DateTime
    definition: 'Object declared by the contract with fields: date, time, utc_offset, timezone_identifier.'
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Date_time.v1
  - term: EmailHeader
    definition: Email Header
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Email_header.v1
  - term: OrderV2
    definition: The order object contains at least 1 order number (`order.number`) or 1 tracking information (`order.trackings.tracking_number`).
      See [Minimum Valid Parsing Result](../../docs/other/minimum_valid_parsing_result.md).
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Order.v2
  - term: Money
    definition: Order total amount.
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Order_total.v1
  - term: Money
    definition: Order subtotal amount.
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Subtotal.v1
  - term: Order
    definition: The order object contains at least 1 order information (`order.order_number` + `order.store`) or 1 tracking information (`order.trackings.n.tracking_number`).
      See [Minimum Valid Parsing Result](../../docs/other/minimum_valid_parsing_result.md).
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Order.v1
  - term: Money
    definition: Total shipping amount.
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Shipping_total.v1
  - term: MoneyV2
    definition: The money object is used to represent the currency amount. In some cases, if it cannot parse the currency from the symbol, the
      currency will be null while the symbol will have a value.
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Money.v2
  - term: PickupV2
    definition: Order pickup information parsed from the email.
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Pickup.v2
  - term: DateTimeV2
    definition: 'Object declared by the contract with fields: date, time, utc_offset, timezone_identifier.'
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Date_time.v2
  - term: PickupLocationV2
    definition: Pickup location. The order pickup point.
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Pickup_location.v2
  - term: PhoneV2
    definition: The phone number object.
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Phone.v2
  - term: EstimatedDeliveryDateTime
    definition: It refers to the estimated delivery datetime parsed from the email. The maximum will be null if the estimated delivery datetime
      does not have a valid time range.
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Estimated_delivery_datetime.v2
  - term: OrderItemV2
    definition: The product item of an order or a tracking.
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Order_item.v2
  - term: MoneyV2
    definition: Total discount amount.
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Discount_total.v2
  - term: ShippingMethod
    definition: The shipping method.
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Shipping_method.v1
  - term: MoneyV2
    definition: Total shipping amount.
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Shipping_total.v2
  - term: MoneyV2
    definition: Order subtotal amount.
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Subtotal.v2
  - term: Money
    definition: Total discount amount.
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Discount_total.v1
  - term: Phone
    definition: The phone number object.
    tags:
    - Object
    source: openapi/aftership-email-parses-api-openapi.yml#/components/schemas/Phone.v1