input WarehouseProfileCreateInput

Fields

FieldTypeDescription
warehouse_idString!

Public API ID of the physical warehouse that will own this profile.

profileString!

Non-default profile name.

invoice_addressWarehouseProfileAddressInput!

Sender/company address displayed on invoices.

label_addressWarehouseProfileAddressInput!

Return address displayed on shipping labels.

phone_numberString

Contact phone number.

invoice_emailString

Invoice contact email.

invoice_noteString

Note displayed on invoices.

invoice_logo_urlString

Public HTTPS URL of a PNG or JPEG logo. ShipHero downloads and stores the image in S3.

languageString

Invoice language code.

manual_order_prefixString

Prefix for manual orders, up to 10 characters.

show_phone_on_invoiceBoolean

Whether to display the phone number on invoices.

only_pick_orders_with_required_ship_date_today_or_earlierBoolean

Whether picking is limited to orders required to ship today or earlier.

exclude_stock_from_available_to_sellBoolean

Whether this warehouse profile's stock is excluded from available-to-sell calculations.

Referenced By

Example

{
  "warehouse_id": "abc123",
  "profile": "Retail Store",
  "invoice_address": WarehouseProfileAddressInput,
  "label_address": WarehouseProfileAddressInput,
  "phone_number": "+1-555-0100",
  "invoice_email": "invoices@example.com",
  "invoice_note": "Thank you for your order.",
  "invoice_logo_url": "abc123",
  "language": "en",
  "manual_order_prefix": "MO",
  "show_phone_on_invoice": true,
  "only_pick_orders_with_required_ship_date_today_or_earlier": true,
  "exclude_stock_from_available_to_sell": true
}