Whiplash Merchandising shipnotices API
A Shipnotice is the opposite of an order, and are notifications by the client of inventory that is expected to arrive at a warehouse. Shipnotices represent incoming stock.
OpenAPI Specification
openapi: 3.1.0
info:
version: '2.0'
title: Rydership bundle_items shipnotices 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: shipnotices
description: 'A Shipnotice is the opposite of an order, and are notifications by the client of inventory that is expected to arrive at a warehouse.
Shipnotices represent incoming stock.'
paths:
/api/v2/shipnotices:
get:
operationId: GetApiV2Shipnotices
tags:
- shipnotices
summary: List all ship notices
description: Get all shipnotices
parameters:
- name: search
in: query
required: false
schema:
type: string
description: 'JSON search string like {"attribute_eq": "Term"}'
- name: fields
in: query
required: false
schema:
type: string
description: Comma-separated list of fields to include in the response
- name: sort
in: query
required: false
schema:
type: string
description: 'A list of sort options (ex: name asc,created_at desc)'
- name: page
in: query
required: false
schema:
type: integer
format: int32
description: Page of results to fetch
- name: per_page
in: query
required: false
schema:
type: integer
format: int32
description: Number of results to return per page
- name: page_total
in: query
required: false
schema:
type: boolean
description: Include total count of results
- name: page_links
in: query
required: false
schema:
type: boolean
description: Include prev/next links in response headers
responses:
'200':
description: Get all shipnotices
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiV2EntitiesShipnotice'
examples:
api.v2.shipnotice.all:
$ref: '#/components/examples/api.v2.shipnotice.all'
'401':
description: unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
'403':
description: forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
post:
operationId: PostApiV2Shipnotices
tags:
- shipnotices
summary: Create a ship notice
description: Create a shipnotice
parameters: []
responses:
'201':
description: Create a shipnotice
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/PostApiV2ShipnoticesRequest'
/api/v2/shipnotices/actions:
get:
operationId: GetApiV2ShipnoticesActions
tags:
- shipnotices
summary: List actions you can perform
description: Get resource actions
parameters: []
responses:
'401':
description: unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
'403':
description: forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
/api/v2/shipnotices/bulk:
post:
operationId: PostApiV2ShipnoticesBulk
tags:
- shipnotices
summary: Create shipnotices in bulk
description: Create shipnotices in bulk
parameters: []
responses:
'201':
description: Create shipnotices in bulk
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiV2EntitiesResult'
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/PostApiV2ShipnoticesBulkRequest'
/api/v2/shipnotices/count:
get:
operationId: GetApiV2ShipnoticesCount
tags:
- shipnotices
summary: Count ship notices
description: Returns count of shipnotices
parameters:
- name: search
in: query
required: false
schema:
type: string
description: 'JSON search string like {"attribute_eq": "Term"}'
responses:
'200':
description: Returns count of shipnotices
content:
application/json:
schema:
$ref: '#/components/schemas/ApiV2EntitiesCount'
examples: null
'401':
description: unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
'403':
description: forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
/api/v2/shipnotices/{id}:
get:
operationId: GetApiV2ShipnoticesId
tags:
- shipnotices
summary: Retrieve a ship notice
description: Get a Shipnotice
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
'200':
description: Get a Shipnotice
content:
application/json:
schema:
$ref: '#/components/schemas/ApiV2EntitiesShipnotice'
examples:
api.v2.shipnotice.processing:
$ref: '#/components/examples/api.v2.shipnotice.processing'
'401':
description: unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
'403':
description: forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
put:
operationId: PutApiV2ShipnoticesId
tags:
- shipnotices
summary: Update a ship notice
description: Update a shipnotice
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
'200':
description: Update a shipnotice
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'
'422':
description: unprocessable_entity
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PutApiV2ShipnoticesIdRequest'
delete:
operationId: DeleteApiV2ShipnoticesId
tags:
- shipnotices
summary: Destroy a ship notice
description: Destroy a shipnotice
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
'204':
description: Successfully deleted
'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'
/api/v2/shipnotices/{id}/meta_fields:
get:
operationId: GetApiV2ShipnoticesIdMetaFields
tags:
- shipnotices
summary: List meta fields
description: Get the meta fields for a(n) Shipnotice
parameters:
- name: id
in: path
required: true
schema:
type: integer
- name: associations
in: query
required: false
schema:
type: array
description: Include meta fields for associations
items:
type: string
responses:
'200':
description: Get the meta fields for a(n) Shipnotice
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesMetaFields'
examples: null
'401':
description: unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
'403':
description: forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
put:
operationId: PutApiV2ShipnoticesIdMetaFields
tags:
- shipnotices
summary: Set meta fields
description: Update Shipnotice meta fields
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
'204':
description: Successfully updated
'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/PutApiV2ShipnoticesIdMetaFieldsRequest'
/api/v2/shipnotices/{id}/orders_waiting:
get:
operationId: GetApiV2ShipnoticesIdOrdersWaiting
tags:
- shipnotices
summary: Count orders waiting for stock in a ship notice
description: Get the count of orders waiting for the shipnotice
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
'200':
description: Get the count of orders waiting for the shipnotice
content:
application/json:
schema:
$ref: '#/components/schemas/ApiV2EntitiesCount'
examples: null
'401':
description: unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
'403':
description: forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
/api/v2/shipnotices/{id}/shipnotice_items:
get:
operationId: GetApiV2ShipnoticesIdShipnoticeItems
tags:
- shipnotices
summary: List associated ship notice items
description: List all shipnotice items for a(n) shipnotice
parameters:
- name: id
in: path
required: true
schema:
type: integer
- name: search
in: query
required: false
schema:
type: string
description: 'JSON search string like {"attribute_eq": "Term"}'
- name: fields
in: query
required: false
schema:
type: string
description: Comma-separated list of fields to include in the response
- name: sort
in: query
required: false
schema:
type: string
description: 'A list of sort options (ex: name asc,created_at desc)'
- name: page
in: query
required: false
schema:
type: integer
format: int32
description: Page of results to fetch
- name: per_page
in: query
required: false
schema:
type: integer
format: int32
description: Number of results to return per page
- name: page_total
in: query
required: false
schema:
type: boolean
description: Include total count of results
- name: page_links
in: query
required: false
schema:
type: boolean
description: Include prev/next links in response headers
responses:
'200':
description: List all shipnotice items for a(n) shipnotice
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiV2EntitiesShipnoticeItem'
examples: null
'401':
description: unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
'403':
description: forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
post:
operationId: PostApiV2ShipnoticesIdShipnoticeItems
tags:
- shipnotices
summary: Create a ship notice item
description: create a shipnotice item
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
'201':
description: create a shipnotice item
content:
application/json:
schema:
$ref: '#/components/schemas/ApiV2EntitiesShipnoticeItem'
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/PostApiV2ShipnoticesIdShipnoticeItemsRequest'
/api/v2/shipnotices/{id}/shipnotice_items/count:
get:
operationId: GetApiV2ShipnoticesIdShipnoticeItemsCount
tags:
- shipnotices
summary: Count associated ship notice items
description: Get a count of shipnotice items for a(n) shipnotice
parameters:
- name: id
in: path
required: true
schema:
type: integer
- name: search
in: query
required: false
schema:
type: string
description: 'JSON search string like {"attribute_eq": "Term"}'
responses:
'200':
description: Get a count of shipnotice items for a(n) shipnotice
content:
application/json:
schema:
$ref: '#/components/schemas/ApiV2EntitiesCount'
examples: null
'401':
description: unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
'403':
description: forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
components:
examples:
api.v2.shipnotice.all:
summary: shipnotice.all[]
value:
- id: 1044
customer_id: 200
warehouse_id: 1
sender: Reichel, Borer and Barton
eta: '2026-03-20T00:00:00.000-04:00'
status: 300
status_name: Completed
received_by: null
notes_by_whiplash: Amet ut sapiente doloribus exercitationem ipsa sed sunt assumenda adipisci.
notes_by_customer: Velit laboriosam neque ea odit eum aspernatur assumenda similique facere.
total_boxes: null
created_at: '2026-03-13T11:39:21.000-04:00'
updated_at: '2026-03-13T11:39:21.000-04:00'
arrived_at: '2026-03-11T11:39:21.000-04:00'
skip_images: null
easypostable_id: null
easypostable_type: Shipment
shipping_label_url: null
ship_actual_cost: null
shipping_method_text: null
carrier: null
shipping_method_id: null
tracking: '8276816948'
order_id: null
type: Shipnotice
postage_billed: null
handling_billed: null
ship_3rdparty_cost: null
requires_label: true
completed_at: '2026-03-13T11:39:21.000-04:00'
complete_by: '2026-03-14T11:39:21.000-04:00'
ship_actual_currency: null
delivered_at: '2026-03-11T11:39:21.000-04:00'
due_at: null
meta_data: null
reference: null
shipnotice_item_count: 0
shipnotice_item_sku_count: 0
shipnotice_item_quantity: 0
purchase_order_numbers: []
quantities_verified: null
bol_proxy: null
mid_code: null
zone_status: null
originator:
id: 1043
originated_id: null
originated_type: Shipnotice
shop_id: null
provider: api
original_id: '95185268'
group_id: '50361'
misc: null
active: true
integration_id: null
last_notified_at: null
last_notification_status: null
last_synced_at: null
distinct_originator_key: null
created_at: '2026-03-13T11:39:21.000-04:00'
updated_at: '2026-03-13T11:39:21.000-04:00'
application_id: 1
customer:
id: 200
name: Whiplash
created_at: '2011-10-12T18:39:17.000-04:00'
active: true
auto_merge_gestation: 10
default_warehouse_id: 1
eori_number: null
estimated_monthly_volume: null
fedex_account: ''
from_email: null
instructions: ''
item_scanning_preference: true
label_format: ''
notes: null
notify_originator: false
notify_originator_inventory: 1
originator_permissions: true
packing_slip_msg: Whiplash warehouses your products and ships directly to your customers on demand.
packingslip_template: ''
request_serial_numbers: false
ship_method_preference: 1
shipping_name: Whiplash
ups_account: ''
vat_number: ''
ein: null
gs1_company_prefix: null
warehouse_fallback: 0
payment_hold: false
primary_contact: ray+customer@getwhiplash.com
global_e_guid: null
whitelisted_warehouses:
- id: 1
name: Ann Arbor
timezone: Eastern Time (US & Canada)
timezone_raw: America/New_York
partner_id: 1
shipping_address_1: 4657 Platt Road
shipping_address_2: ''
shipping_city: Ann Arbor
shipping_state: Michigan
shipping_zip: '48108'
shipping_country: United States
shipping_country_iso2: US
latitude: 42.2206
longitude: -83.6989
slug: ann-arbor
- id: 2
name: San Francisco
timezone: Pacific Time (US & Canada)
timezone_raw: America/Los_Angeles
partner_id: 1
shipping_address_1: 1334 San Mateo Avenue
shipping_address_2: ''
shipping_city: South San Francisco
shipping_state: California
shipping_zip: '94080'
shipping_country: United States
shipping_country_iso2: US
latitude: 37.6432
longitude: -122.41
slug: san-francisco
- id: 3
name: London
timezone: Edinburgh
timezone_raw: Europe/London
partner_id: 1
shipping_address_1: 19 Alston drive
shipping_address_2: Bradwell Abbey
shipping_city: Milton Keynes
shipping_state: ''
shipping_zip: MK13 9HA
shipping_country: United Kingdom
shipping_country_iso2: GB
latitude: 52.0464
longitude: -0.798371
slug: london
- id: 4
name: Ypsilanti
timezone: Eastern Time (US & Canada)
timezone_raw: America/New_York
partner_id: 1
shipping_address_1: 291 Airport Industrial Drive
shipping_address_2: ''
shipping_city: Ypsilanti
shipping_state: Michigan
shipping_zip: '48198'
shipping_country: United States
shipping_country_iso2: US
latitude: 42.2404
longitude: -83.5708
slug: ypsilanti
- id: 5
name: Cypress
timezone: Pacific Time (US & Canada)
timezone_raw: America/Los_Angeles
partner_id: 1
shipping_address_1: 10731 Walker Street
shipping_address_2: Suite B
shipping_city: Cypress
shipping_state: California
shipping_zip: '90630'
shipping_country: United States
shipping_country_iso2: US
latitude: 33.8074
longitude: -118.038
slug: cypress
- id: 6
name: Montreal
timezone: Eastern Time (US & Canada)
timezone_raw: America/New_York
partner_id: 1
shipping_address_1: 6620 Rue Abrams
shipping_address_2: ''
shipping_city: Saint Laurent
shipping_state: Quebec
shipping_zip: H4S 1Y1
shipping_country: Canada
shipping_country_iso2: CA
latitude: 45.4893
longitude: -73.757
slug: montreal
allowed_warehouse_ids:
- 1
- 2
- 3
- 4
- 5
- 6
account_level: 400
account_level_name: null
activated_at: '2015-05-01T00:06:25.000-04:00'
deactivated_at: null
auto_merge_skus: false
billing_email: whiplash@whiplashmerch.com
billing_contact_name: James Marks
billing_company: Whiplash Merchandising
billing_phone1: ''
billing_phone2: ''
billing_address1: 4657 Platt Road
billing_address2: ''
billing_address3: null
billing_city: Ann Arbor
billing_state: MI
billing_zip: '48108'
billing_country: US
billing_residential: null
items_returnable: true
allow_international_returns: true
items_exchangeable: true
return_time_limit: 30
return_label_expires_in: 29
return_price_restricted: true
return_sku_match: null
rma_display_logo: true
rma_footer_content: null
return_name: null
return_company: null
return_email: null
return_phone: null
return_address_1: null
return_address_2: null
return_city: null
return_state: null
return_zip: null
return_country: null
supports_return_labels: true
logo_content_type: image/jpeg
logo_file_name: whiplash-stacked-600dpi.jpg
logo_file_size: 758106
logo_updated_at: '2016-04-27T19:00:17.000-04:00'
full_logo_url: https://s3.amazonaws.com/mark-dickson-core-uploads/logos/customer/200/original_whiplash-stacked-600dpi.jpg?1461798017
email_confirmation_from: whiplash@whiplashmerch.com
email_confirmation_name: Whiplash Merch
email_confirmation_msg: Thanks for checking out WhiplashMerch.com!
email_confirmation_preference: 1
email_confirmation_template: ''
low_inventory_threshold: null
lot_control: false
expiration_period: null
ship_strategy: 1
items_unavailable_on_sellout: 1
replenishment_min: null
replenishment_target: null
allow_b_stock_receiving: false
location_default_return_role: pickable
location_enable_pending_returns: false
location_enable_receiving_into_reserved: false
receiving_fields: null
project_task_labels: null
dashboard_enable_domo: true
dashboard_enable_parcel_insights: false
warehouse:
id: 1
name: Ann Arbor
timezone: Eastern Time (US & Canada)
timezone_raw: America/New_York
partner_id: 1
shipping_address_1: 4657 Platt Road
shipping_address_2: ''
shipping_city: Ann Arbor
shipping_state: Michigan
shipping_zip: '48108'
shipping_country: United States
shipping_country_iso2: US
latitude: 42.2206
longitude: -83.6989
slug: ann-arbor
inspection_required: false
shipping_method: null
shipnotice_items: []
processing_started_at: '2026-03-11T11:39:21.000-04:00'
- id: 1046
customer_id: 200
warehouse_id: 1
sender: Johnston Inc
eta: '2026-03-20T00:00:00.000-04:00'
status: 100
status_name: In Transit
received_by: null
notes_by_whiplash: Doloremque mollitia vero aut aut totam eum numquam nam rerum.
notes_by_customer: Voluptatem maxime optio nihil nulla aut et quasi nesciunt earum.
total_boxes: null
created_at: '2026-03-13T11:39:21.000-04:00'
updated_at: '2026-03-13T11:39:21.000-04:00'
arrived_at: null
skip_images: null
easypostable_id: null
easypostable_type: Shipment
shipping_label_url: null
ship_actual_cost: null
shipping_method_text: null
carrier: null
shipping_method_id: null
tracking: '8975350812'
order_id: null
type: Shipnotice
postage_billed: null
handling_billed: null
ship_3rdparty_cost: null
requires_label: true
completed_at: null
complete_by: '2026-03-23T00:00:00.000-04:00'
ship_actual_currency: null
delivered_at: null
due_at: null
meta_data: null
reference: null
shipnotice_item_count: 1
shipnotice_item_sku_count: 1
shipnotice_item_quantity: 1
purchase_order_numbers: []
quantities_verified: null
bol_proxy: null
mid_code: null
zone_status: null
originator:
id: 1045
originated_id: null
originated_type: Shipnotice
shop_id: null
provider: api
original_id: '73487184'
group_id: '40971'
misc: null
active: true
integration_id: null
last_notified_at: null
last_notification_status: null
last_synced_at: null
distinct_originator_key: null
created_at: '2026-03-13T11:39:21.000-04:00'
updated_at: '2026-03-13T11:39:21.000-04:00'
application_id: 1
customer:
id: 200
name: Whiplash
created_at: '2011-10-12T18:39:17.000-04:00'
active: true
auto_merge_gestation: 10
default_warehouse_id: 1
eori_number: null
estimated_monthly_volume: null
fedex_account: ''
from_email: null
instructions: ''
item_scanning_preference: true
label_format: ''
notes: null
notify_originator: false
notify_originator_inventory: 1
originator_permissions: true
packing_slip_msg: Whiplash warehouses your products and ships directly to your customers on demand.
packingslip_template: ''
request_serial_numbers: false
ship_method_preference: 1
shipping_name: Whiplash
ups_account: ''
vat_number: ''
ein: null
gs1_company_prefix: null
warehouse_fallback: 0
payment_hold: false
primary_contact: ray+customer@getwhiplash.com
global_e_guid: null
whitelisted_warehouses:
- id: 1
name: Ann Arbor
timezone: Eastern Time (US & Canada)
timezone_raw: America/New_York
partner_id: 1
shipping_address_1: 4657 Platt Road
# --- truncated at 32 KB (164 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/whiplash-merchandising/refs/heads/main/openapi/whiplash-merchandising-shipnotices-api-openapi.yml