Whiplash Merchandising simulate API

openapi: 3.2.0
info:
  version: '2.0'
  title: Rydership bundle_items Simulate API
  description: 'The Rydership V2 API is open by invite only. Fill out request form <a href="https://help.whiplash.com/hc/en-us/requests/new?ticket_form_id=360001303092"> here</a>.

    <br>

    <a href="api.v2.html">V2 documentation</a>

    <br>

    <a href="api.v2-1.html">V2.1 documentation</a>

    '
  contact:
    name: Rydership Development Team
    email: tech@whiplash.com
    url: https://www.getwhiplash.com
  x-logo:
    url: https://wl-s3-assets.s3.amazonaws.com/rydership/RyderShip-horizontal-safe-padding.svg
    backgroundColor: '#FFFFFF'
    altText: RyderShip
servers:
- url: ''
  description: Base Path
tags:
- name: simulate
  description: (Sandbox Only) Simulate Order and Ship Notice processing, since these are staff-only operations.
paths:
  /api/v2/simulate/consumer_returns/create:
    post:
      operationId: PostApiV2SimulateConsumerReturnsCreate
      tags:
      - simulate
      summary: Create a consumer return with simulated data
      description: Create a consumer_return with simulated data
      parameters: []
      responses:
        '201':
          description: Create a consumer_return with simulated data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiV2EntitiesConsumerReturn'
              examples: null
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '409':
          description: conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '422':
          description: unprocessable_entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV2SimulateConsumerReturnsCreateRequest'
  /api/v2/simulate/consumer_returns/{consumer_return_id}/processing:
    put:
      operationId: PutApiV2SimulateConsumerReturnsConsumerReturnIdProcessing
      tags:
      - simulate
      summary: Simulate processing for an consumer return
      description: Simulate processing for a consumer_return, received through finalized
      parameters:
      - name: consumer_return_id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Simulate processing for a consumer_return, received through finalized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiV2EntitiesConsumerReturn'
              examples: null
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '422':
          description: unprocessable_entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutApiV2SimulateConsumerReturnsConsumerReturnIdProcessingRequest'
  /api/v2/simulate/orders/create:
    post:
      operationId: PostApiV2SimulateOrdersCreate
      tags:
      - simulate
      summary: Create an order with simulated data
      description: Create an order with simulated data
      parameters: []
      responses:
        '201':
          description: Create an order with simulated data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiV2EntitiesOrder'
              examples: null
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '409':
          description: conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '422':
          description: unprocessable_entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV2SimulateOrdersCreateRequest'
  /api/v2/simulate/orders/{order_id}/processing:
    put:
      operationId: PutApiV2SimulateOrdersOrderIdProcessing
      tags:
      - simulate
      summary: Simulate processing for an order
      description: Simulate processing for an order, packed through shipped
      parameters:
      - name: order_id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Simulate processing for an order, packed through shipped
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiV2EntitiesOrder'
              examples:
                api.v2.order.processing:
                  $ref: '#/components/examples/api.v2.order.processing'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '422':
          description: unprocessable_entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutApiV2SimulateOrdersOrderIdProcessingRequest'
  /api/v2/simulate/shipnotices/create:
    post:
      operationId: PostApiV2SimulateShipnoticesCreate
      tags:
      - simulate
      summary: Create a shipnotice with simulated data
      description: Create a shipnotice with simulated data
      parameters: []
      responses:
        '201':
          description: Create a shipnotice with simulated data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiV2EntitiesShipnotice'
              examples:
                api.v2.shipnotice.in_transit:
                  $ref: '#/components/examples/api.v2.shipnotice.in_transit'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '409':
          description: conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '422':
          description: unprocessable_entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV2SimulateShipnoticesCreateRequest'
  /api/v2/simulate/shipnotices/{shipnotice_id}/processing:
    put:
      operationId: PutApiV2SimulateShipnoticesShipnoticeIdProcessing
      tags:
      - simulate
      summary: Simulate processing for an ship notice
      description: Simulate processing for a shipnotice, received through finalized
      parameters:
      - name: shipnotice_id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Simulate processing for a shipnotice, received through finalized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiV2EntitiesShipnotice'
              examples: null
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '422':
          description: unprocessable_entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutApiV2SimulateShipnoticesShipnoticeIdProcessingRequest'
components:
  schemas:
    ApiV2EntitiesCustomer:
      type: object
      title: V2
      properties:
        id:
          type: integer
          format: int32
          description: the customer id
        name:
          type: string
          description: Customer name.
        created_at:
          type:
          - string
          - 'null'
          format: date-time
          description: the customer creation date and time
        active:
          type:
          - boolean
          - 'null'
          description: Customer active?
        auto_merge_gestation:
          type:
          - integer
          - 'null'
          format: int32
          description: Customer auto merge gestation.
        default_warehouse_id:
          type:
          - integer
          - 'null'
          format: int32
          description: Customer default warehouse id.
        eori_number:
          type:
          - string
          - 'null'
          description: Customer EORI number.
        estimated_monthly_volume:
          type:
          - string
          - 'null'
          description: Customer estimated monthly volume.
        fedex_account:
          type:
          - string
          - 'null'
          description: Customer FedEx account.
        from_email:
          type:
          - string
          - 'null'
          description: Customer from email.
        incoterm:
          type: string
          description: Customer incoterm.
        instructions:
          type:
          - string
          - 'null'
          description: Customer instructions.
        item_scanning_preference:
          type:
          - boolean
          - 'null'
          description: Customer has item scanning preference?
        label_format:
          type:
          - string
          - 'null'
          description: Customer label format.
        notes:
          type:
          - string
          - 'null'
          description: Customer notes.
        notify_originator:
          type:
          - boolean
          - 'null'
          description: notify originator?
        notify_originator_inventory:
          type:
          - integer
          - 'null'
          format: int32
          description: Customer notify originator inventory.
        originator_permissions:
          type:
          - boolean
          - 'null'
          description: originator permissions?
        packing_slip_msg:
          type:
          - string
          - 'null'
          description: Customer packing slip message.
        packingslip_template:
          type:
          - string
          - 'null'
          description: Customer packing slip template.
        request_serial_numbers:
          type:
          - boolean
          - 'null'
          description: request serial numbers?
        ship_method_preference:
          type:
          - integer
          - 'null'
          format: int32
          description: Customer shipping method preference.
        shipping_name:
          type:
          - string
          - 'null'
          description: Customer shipping name.
        ups_account:
          type:
          - string
          - 'null'
          description: Customer UPS account.
        vat_number:
          type:
          - string
          - 'null'
          description: Customer VAT number.
        ein:
          type:
          - string
          - 'null'
          description: Customer EIN / Tax ID
        gs1_company_prefix:
          type:
          - string
          - 'null'
          description: GS1 company prefix for barcodes
        warehouse_fallback:
          type:
          - integer
          - 'null'
          format: int32
          description: Customer warehouse fallback.
        payment_hold:
          type: boolean
          description: is this account on hold pending a valid payment method?
        primary_contact:
          type: string
          description: The Customers designated primary contact.
        global_e_guid:
          type:
          - string
          - 'null'
          description: Customer Global-E GUID.
        exit_notice:
          type:
          - boolean
          - 'null'
          description: is this account flagged for exit notice? (admins only)
        data_mapping_string:
          type:
          - string
          - 'null'
          description: Data mapping string for this customer. (admins only)
        whitelisted_warehouses:
          $ref: '#/components/schemas/ApiV2EntitiesWarehouse'
        allowed_warehouse_ids:
          type: array
          items:
            type: integer
            format: int32
        account_level:
          type: integer
          format: int32
          description: Account level
        account_level_name:
          type: string
          description: Quote, Direct, Enterprise, or Managed
        activated_at:
          type:
          - string
          - 'null'
          format: date-time
          description: the customer activation date and time
        deactivated_at:
          type:
          - string
          - 'null'
          format: date-time
          description: the customer deactivation date and time
        auto_merge_skus:
          type:
          - boolean
          - 'null'
          description: auto merge SKUs?
        partner_id:
          type:
          - integer
          - 'null'
          format: int32
          description: Customer partner id. (admins only)
        billing_email:
          type:
          - string
          - 'null'
          description: Customer billing email.
        billing_contact_name:
          type:
          - string
          - 'null'
          description: Customer billing contact name.
        billing_company:
          type:
          - string
          - 'null'
          description: Customer billing company.
        billing_phone1:
          type:
          - string
          - 'null'
          description: Customer phone 1.
        billing_phone2:
          type:
          - string
          - 'null'
          description: Customer phone 2.
        billing_address1:
          type:
          - string
          - 'null'
          description: Customer billing address line 1.
        billing_address2:
          type:
          - string
          - 'null'
          description: Customer billing address line 2.
        billing_address3:
          type:
          - string
          - 'null'
          description: Customer billing address line 3.
        billing_city:
          type:
          - string
          - 'null'
          description: Customer billing city.
        billing_state:
          type:
          - string
          - 'null'
          description: Customer billing state.
        billing_zip:
          type:
          - string
          - 'null'
          description: Customer billing zip.
        billing_country:
          type:
          - string
          - 'null'
          description: Customer billing country.
        billing_residential:
          type:
          - boolean
          - 'null'
          description: Customer billing residential?
        items_returnable:
          type:
          - boolean
          - 'null'
          description: items returnable by default?
        allow_international_returns:
          type: boolean
          description: Allow International returns?
        items_exchangeable:
          type:
          - boolean
          - 'null'
          description: items exchangeable by default?
        return_time_limit:
          type:
          - integer
          - 'null'
          format: int32
          description: Return time limit.
        return_label_expires_in:
          type:
          - integer
          - 'null'
          format: int32
          description: Return label expiration time limit.
        return_price_restricted:
          type:
          - boolean
          - 'null'
          description: limit exchange to same value or less?
        return_sku_match:
          type:
          - string
          - 'null'
          description: Exchange SKU match policy.
        rma_display_logo:
          type:
          - boolean
          - 'null'
          description: display customer logo on returns page?
        rma_footer_content:
          type:
          - string
          - 'null'
          description: Return page footer content.
        return_name:
          type:
          - string
          - 'null'
          description: Customer return name.
        return_company:
          type:
          - string
          - 'null'
          description: Customer return company.
        return_email:
          type:
          - string
          - 'null'
          description: Customer return email.
        return_phone:
          type:
          - string
          - 'null'
          description: Customer return phone.
        return_address_1:
          type:
          - string
          - 'null'
          description: Customer return address line 1.
        return_address_2:
          type:
          - string
          - 'null'
          description: Customer return address line 2.
        return_city:
          type:
          - string
          - 'null'
          description: Customer return city.
        return_state:
          type:
          - string
          - 'null'
          description: Customer return state.
        return_zip:
          type:
          - string
          - 'null'
          description: Customer return zip.
        return_country:
          type:
          - string
          - 'null'
          description: Customer return country.
        supports_return_labels:
          type:
          - boolean
          - 'null'
          description: does the customer support return labels?
        logo_content_type:
          type:
          - string
          - 'null'
          description: Customer logo content type.
        logo_file_name:
          type:
          - string
          - 'null'
          description: Customer logo file name.
        logo_file_size:
          type:
          - integer
          - 'null'
          format: int32
          description: Customer logo file size.
        logo_updated_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Customer logo updated at.
        full_logo_url:
          type: string
          description: Customer full logo url.
        email_confirmation_from:
          type:
          - string
          - 'null'
          description: Customer email confirmation from.
        email_confirmation_name:
          type:
          - string
          - 'null'
          description: Customer email confirmation name.
        email_confirmation_msg:
          type:
          - string
          - 'null'
          description: Customer email confirmation message.
        email_confirmation_preference:
          type:
          - integer
          - 'null'
          format: int32
          description: Customer email confirmation preference.
        email_confirmation_template:
          type:
          - string
          - 'null'
          description: Customer email confirmation template.
        low_inventory_threshold:
          type:
          - integer
          - 'null'
          format: int32
          description: Quantity where an item in inventory would be considered having low inventory
        lot_control:
          type:
          - boolean
          - 'null'
          description: do items for this customer require lot control?
        expiration_period:
          type:
          - integer
          - 'null'
          format: int32
          description: items that are this many days from expiration will not be allowed to ship
        ship_strategy:
          type:
          - integer
          - 'null'
          format: int32
          description: 'which locations to pick first: Default, FIFO, FEFO'
        items_unavailable_on_sellout:
          type:
          - integer
          - 'null'
          format: int32
          description: 'Process Orders setting: Whiplash will automatically turn on Process Orders when an item is received, and turn it off when an item sells. Whiplash will not manage Process Orders. Whiplash will automatically turn on Process Orders only the first time an Item is received. Whiplash will automatically turn on Process Orders when an item is received or adjusted in, and turn it off when an Item sells out.'
        replenishment_min:
          type:
          - string
          - 'null'
          description: Minimum number of days worth of stock to keep in forward pick locations
        replenishment_target:
          type:
          - string
          - 'null'
          description: Target number of days stock to replenish forward pick locations
        allow_b_stock_receiving:
          type:
          - boolean
          - 'null'
          description: Allow "b stock" role for receiving
        location_default_return_role:
          type: string
          description: Default role (i.e. Pickable, Damaged) for returned items
        location_enable_pending_returns:
          type: boolean
          description: Allow "pending" role for returned items
        location_enable_receiving_into_reserved:
          type: boolean
          description: Allow "reserved" role for receiving items
        receiving_fields:
          type: array
          items:
            type: object
        project_task_labels:
          type: array
          items:
            type: string
        dashboard_enable_domo:
          type: string
          description: Enable Domo dashboard for this customer
        dashboard_enable_parcel_insights:
          type: string
          description: Enable Parcel Insights for this customer
        gestation_length:
          type:
          - string
          - 'null'
          description: Customer gestation length in hours.
        billing_core:
          type:
          - boolean
          - 'null'
          description: if false, disables hardcoded billing logic (staff only)
      additionalProperties: false
    PostApiV2SimulateShipnoticesCreateRequest:
      type: object
      properties:
        shipnotice_id:
          type: integer
          format: int32
          description: Shipnotice id
    PostApiV2SimulateConsumerReturnsCreateRequest:
      type: object
      properties:
        consumer_return_id:
          type: integer
          format: int32
          description: ConsumerReturn id
    ApiV2EntitiesWholesaleItem:
      type: object
      title: V2
      properties:
        id:
          type: integer
          format: int32
          description: the wholesale item id
        order_item_id:
          type: integer
          format: int32
          description: the associated order item id
        line_no:
          type:
          - string
          - 'null'
          description: the line number
        item_alias:
          type:
          - string
          - 'null'
          description: the item alias
        item_color:
          type:
          - string
          - 'null'
          description: the item color
        item_size:
          type:
          - string
          - 'null'
          description: the item size
        vendor_part_number:
          type:
          - string
          - 'null'
          description: the vendor part number
        buyer_part_number:
          type:
          - string
          - 'null'
          description: the buyer part number
        consumer_package_code:
          type:
          - string
          - 'null'
          description: the consumer package code
        outer_pack_value:
          type:
          - string
          - 'null'
          description: the outer pack value
        inner_pack_value:
          type:
          - string
          - 'null'
          description: the inner pack value
        size_description:
          type:
          - string
          - 'null'
          description: the size description
        color_description:
          type:
          - string
          - 'null'
          description: the color description
        upc:
          type:
          - string
          - 'null'
          description: the UPC
        description:
          type:
          - string
          - 'null'
          description: the description
        style:
          type:
          - string
          - 'null'
          description: the style
        ean:
          type:
          - string
          - 'null'
          description: the EAN
        alternate_item_number:
          type:
          - string
          - 'null'
          description: the alternate item number
        alternate_barcode:
          type:
          - string
          - 'null'
          description: the alternate barcode
        alternate_sku:
          type:
          - string
          - 'null'
          description: the alternate SKU
        lot:
          type:
          - string
          - 'null'
          description: the lot
        ih_category:
          type:
          - string
          - 'null'
          description: the IH category
        created_at:
          type: string
          format: date-time
          description: the wholesale item creation date and time
        updated_at:
          type: string
          format: date-time
          description: the wholesale item last update date and time
      additionalProperties: false
    PostApiV2SimulateOrdersCreateRequest:
      type: object
      properties:
        order_id:
          type: integer
          format: int32
          description: Order id
    ApiV2EntitiesShipnoticeItem:
      type: object
      title: V2
      properties:
        id:
          type: integer
          format: int32
          description: the shipnotice item id
        shipnotice_id:
          type:
          - integer
          - 'null'
          format: int32
          description: the ID of the shipnotice that contains this shipnotice_item
        item_id:
          type:
          - integer
          - 'null'
          format: int32
          description: the shipnotice item item id
        quantity:
          type:
          - integer
          - 'null'
          format: int32
          description: the number of this shipnotice item in the shipnotice
        quantity_good:
          type:
          - integer
          - 'null'
          format: int32
          description: how many of this item arrived in acceptable condition
        quantity_damaged:
          type:
          - integer
          - 'null'
          format: int32
          description: how many of this item arrived in damaged condition
        description:
          type:
          - string
          - 'null'
          description: description of the item
        extended_description:
          type:
          - string
          - 'null'
          description: an extended description of the item
        include_in_published:
          type:
          - boolean
          - 'null'
          description: include this item in published amount?
        return_action:
          type:
          - string
          - 'null'
          description: 'action to perform on item return '
        purchase_order_number:
          type: string
          description: the purchase order number associated with the shipnotice item
        created_at:
          type:
          - string
          - 'null'
          format: date-time
          description: the shipnotice item creation date and time
        updated_at:
          type:
          - string
          - 'null'
          format: date-time
          description: the shipnotice item last update date and time
        item:
          $ref: '#/components/schemas/ApiV2EntitiesItem'
        lot:
          $ref: '#/components/schemas/ApiV2EntitiesLot'
        item_image_url:
          type: string
          description: item image url
        item_scancode:
          type: string
          description: item scancode
        item_sku:
          type: string
          description: item sku
        item_title:
          type: string
          description: item title
        item_lot_control:
          type: boolean
          description: item lot control
        item_currency:
          type: string
          description: item currency
        case_quantity:
          type: integer
          format: int32
          description: How many of this item to a case?
        carton_quantity:
          type: integer
          format: int32
          description: How many CASES to a carton?
        goh:
          type: boolean
          description: Garment on hanger?
        unit_cost:
          type:
          - string
          - 'null'
          description: unit cost for this shipnotice item
        warehouse_id:
          type: integer
          format: int32
          description: the ID of the warehouse that is receiving this shipnotice item
        unallocated:
          type: integer
          format: int32
          description: the quantity that has been received good, but not assigned to a location
        location_role:
          type: string
          description: 'the location role into which the item is received. options: pickable (default), damaged, pending, backstock (staff only)'
      additionalProperties: false
    PutApiV2SimulateShipnoticesShipnoticeIdProcessingRequest:
      type: object
      properties:
        finalize:
          type: boolean
          description: Finalize this Shipnotice
        randomize_receiving:
          type: boolean
          description: Randomize quantity to receive on this Shipnotice
    ApiV2EntitiesPackage:
      type: object
      title: V2
      properties:
        id:
          type: integer
          format: int32
          description: the package id
        order_id:
          type:
          - integer
          - 'null'
          format: int32
          description: the package order id
        shipped_on:
          type:
          - string
          - 'null'
          format: date-time
          description: the package shipped on date and time
        ship_actual_cost:
          type:
          - string
          - 'null'
          description: the package shipping cost
        actual_weight:
          type:
          - string
          - 'null'
          description: the package weight (in ounces)
        actual_width:
          type:
          - string
          - 'null'
          description: the package width (in inches)
        actual_height:
          type:
          - string
          - 'null'
          descript

# --- truncated at 32 KB (137 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/whiplash-merchandising/refs/heads/main/openapi/whiplash-merchandising-simulate-api-openapi.yml