GraphQL Schema
The complete surface of the ShipHero Public API. Browse by resource to see how queries, mutations and types relate — or switch to the alphabetical index. New to the API? Start with the GraphQL Primer.
Queries
- account — Fetch account records matching the supplied arguments.
- ad_hoc_charges — Fetch ad hoc charges matching the supplied arguments.
- bill — Fetch bill records matching the supplied arguments.
- bills — Fetch bills matching the supplied arguments.
- carrier_box — Fetch carrier box records matching the supplied arguments.
- carrier_boxes — Fetch carrier boxes matching the supplied arguments.
- custom_box — Fetch custom box records matching the supplied arguments.
- custom_boxes — Fetch custom boxes matching the supplied arguments.
- cycle_count — Fetch cycle count records matching the supplied arguments.
- cycle_counts — Fetch cycle counts matching the supplied arguments.
- expiration_lots — Fetch expiration lots matching the supplied arguments.
- fulfillment_invoice — Fetch fulfillment invoice records matching the supplied arguments.
- fulfillment_invoices — Fetch fulfillment invoices matching the supplied arguments.
- inbound_shipment — Fetch inbound shipment records matching the supplied arguments.
- inbound_shipment_images — Fetch inbound shipment images matching the supplied arguments.
- inbound_shipment_location_summary — Fetch inbound shipment location summary records matching the supplied arguments.
- inbound_shipment_summary — Fetch inbound shipment summary records matching the supplied arguments.
- inbound_shipments — Fetch inbound shipments matching the supplied arguments.
- inventory_changes — Fetch inventory changes matching the supplied arguments.
- inventory_snapshot — Fetch inventory snapshot records matching the supplied arguments.
- inventory_snapshots — Fetch inventory snapshots matching the supplied arguments.
- inventory_sync_items_status — Fetch inventory sync items status matching the supplied arguments.
- inventory_sync_status — Fetch inventory sync status matching the supplied arguments.
- inventory_sync_statuses — Fetch inventory sync statuses matching the supplied arguments.
- item_locations — Fetch item locations matching the supplied arguments.
- labor_jobs — Returns a paginated list of top-level active jobs in a warehouse.
- labor_units — Fetch labor units matching the supplied arguments.
- labor_workers — Returns a paginated list of workers in a warehouse.
- lakehero_data_export — Fetch lakehero data export records matching the supplied arguments.
- location — Fetch location records matching the supplied arguments.
- locations — Fetch locations matching the supplied arguments.
- me — Fetch the authenticated public API user and account context.
- mergeable_orders — Fetch mergeable orders matching the supplied arguments.
- node
- order — Fetch order records matching the supplied arguments.
- order_history — Fetch order history records matching the supplied arguments.
- orders — Fetch orders matching the supplied arguments.
- packers_performance_dashboard — Returns a paginated list of packer performance stats for a warehouse. All duration fields are returned in seconds. Results are ordered by score DESC by default.
- packs_per_day — Gets the details of each shipment's package between the specified dates. Results are sorted by date, warehouse, and user, but they can be filtered by warehouse_id if you are only interested in packages from a particular warehouse. The sorting can be overridden by specifying any other field or list of fields from the output type.
- pickers_performance_dashboard — Returns a paginated list of picker performance stats for a warehouse. All duration fields are returned in seconds. Results are ordered by score DESC by default.
- picks_per_day — Gets the details of each line item picked between the specified dates. Results are sorted by date, warehouse, and user, but they can be filtered by warehouse_id if you are only interested in picks from a particular warehouse. The sorting can be overridden by specifying any other field or list of fields from the output type.
- product — Fetch product records matching the supplied arguments.
- products — Fetch products matching the supplied arguments.
- purchase_order — Fetch purchase order records matching the supplied arguments.
- purchase_orders — Fetch purchase orders matching the supplied arguments.
- recurring_data_export — Fetch recurring data export records matching the supplied arguments.
- return — Fetch return records matching the supplied arguments.
- return_exchange — Fetch return exchange records matching the supplied arguments.
- returns — Fetch returns matching the supplied arguments.
- shipment — Fetch shipment records matching the supplied arguments.
- shipments — Fetch shipments matching the supplied arguments.
- shipping_container — Fetch shipping container records matching the supplied arguments.
- shipping_containers — Fetch shipping containers matching the supplied arguments.
- shipping_plan — Fetch shipping plan records matching the supplied arguments.
- tote — Returns information about a tote. If barcode is set, but warehouse_id is not, it will default to the assigned warehouse id. If no tote is found with that barcode on the specified warehouse, it will return the next tote with the same barcode on any warehouse. It is recommended to use the id field to avoid ambiguity.
- tote_history — Fetch tote history records matching the supplied arguments.
- totes — Fetch totes matching the supplied arguments.
- user — Fetch user records matching the supplied arguments.
- user_quota — User quota for this user quota orders.
- users — Fetch users matching the supplied arguments.
- uuid — When using the old webhooks, you might receive resource IDs as numeric IDs. If you need any of those IDs in one of our new queries or mutations, you can use this query to retrieve the UUID corresponding to that resource or entity's numeric ID.
- vendors — Fetch vendors matching the supplied arguments.
- warehouse_products — Fetch warehouse products matching the supplied arguments.
- webhooks — Fetch webhooks matching the supplied arguments.
- webhooks_call_logs — Returns customer webhook call logs. date_from and date_to are UTC datetimes. If date_to is omitted it defaults to the current UTC time; if date_from is omitted it defaults to one hour before date_to. The maximum allowed period is one week.
- wholesale_order — Fetch wholesale order records matching the supplied arguments.
- wholesale_orders — Fetch wholesale orders matching the supplied arguments.
- wholesale_staging_location_candidates — Fetch wholesale staging location candidates matching the supplied arguments.
- work_order — Fetch work order records matching the supplied arguments.
- work_orders — Fetch work orders matching the supplied arguments.
Mutations
- assembly_add_components
- assembly_clear_components
- assembly_remove_components
- assembly_update_components
- bill_add_ad_hoc_charge
- bill_create
- bill_delete
- bill_recalculate
- bill_submit
- bill_update
- bill_update_ad_hoc_charge
- carrier_box_update
- clear_tote
- custom_box_create
- custom_box_delete
- custom_box_update
- cycle_count_items_create
- cycle_count_locations_create
- cycle_count_recount_create
- inbound_shipment_create
- inbound_shipment_update
- inventory_abort_snapshot
- inventory_add
- inventory_generate_snapshot
- inventory_remove
- inventory_replace
- inventory_subtract
- inventory_sync
- inventory_sync_abort
- inventory_transfer
- item_location_delete
- kit_build
- kit_clear
- kit_remove_components
- license_plate_numbers_create
- location_create
- location_delete
- location_update
- lot_assign_to_location
- lot_create
- lot_delete
- lot_update
- lots_update
- node
- order_add_attachment
- order_add_history_entry
- order_add_line_items
- order_add_tags
- order_bulk_add_tags
- order_bulk_remove_tags
- order_cancel
- order_change_warehouse
- order_clear_tags
- order_create
- order_fulfill
- order_merge
- order_remove_line_items
- order_set_line_item_sku
- order_unmerge
- order_update
- order_update_fulfillment_status
- order_update_holds
- order_update_line_items
- order_update_tags
- product_add_to_warehouse
- product_create
- product_delete
- product_delete_image
- product_update
- purchase_order_add_attachment
- purchase_order_cancel
- purchase_order_close
- purchase_order_create
- purchase_order_set_fulfillment_status
- purchase_order_update
- return_add_attachment
- return_create
- return_create_exchange
- return_receive_line_item
- return_update_status
- shipment_create
- shipment_create_shipping_label
- shipping_container_add_shipping_label
- shipping_container_create
- shipping_container_remove_shipping_label
- shipping_plan_create
- tote_clear
- tote_create
- tote_delete
- tote_transfer_to_location
- tote_update
- user_update
- vendor_add_product
- vendor_create
- vendor_delete
- vendor_remove_product
- warehouse_product_delete
- warehouse_product_update
- webhook_create
- webhook_delete
- webhook_disable
- webhook_enable
- webhook_update_url
- wholesale_order_auto_allocate_for_picking
- wholesale_order_create
- wholesale_order_edit_outbound_schedule
- wholesale_order_fulfill
- wholesale_order_generate_bol_document
- wholesale_order_generate_labels
- wholesale_order_import_packing_layout
- wholesale_order_mark_as_packed
- wholesale_order_print_labels
- wholesale_order_print_manual_picking_sheet
- wholesale_order_print_packing_list
- wholesale_order_print_packing_slip
- wholesale_order_transfer_picks_to_staging
- wholesale_order_update
- wholesale_order_update_picking_flow
- wholesale_order_update_staging_location
- wholesale_set_as_ready_to_pick
- work_order_add_fees
- work_order_auto_assign_pick_locations
- work_order_create
- work_order_remove_fees
- work_order_update_fees
Types
- AbortInventorySyncInput
- AbortInventorySyncOutput
- Account
- AccountConnection
- AccountEdge — A Relay edge containing a `Account` and its cursor.
- AccountLotTrackingSettings
- AccountQueryResult
- AdHocCharge
- AdHocChargeConnection
- AdHocChargeEdge — A Relay edge containing a `AdHocCharge` and its cursor.
- AdHocChargesQueryResult
- AddAssemblyComponentsComponentInput
- AddAssemblyComponentsInput
- AddAssemblyComponentsOutput
- AddBillAdHocChargeInput
- AddBillAdHocChargeOutput
- AddFeeInputType
- AddHistoryInput
- AddLineItemsInput
- AddProductToVendorInput
- AddProductToWarehouseInput
- AddPurchaseOrderAttachmentInput
- AddPurchaseOrderAttachmentOutput
- AddReturnAttachmentInput
- AddReturnAttachmentOutput
- AddShippingLabelToShippingContainerInput
- AddShippingLabelToShippingContainerOutput
- AddWorkOrderFeeInput
- Address
- AddressInput
- AllocatedAllocationType
- AllocationErrorType
- AllocationType
- AssemblyComponent
- AssemblySKUType
- AssignLotToLocationInput — GraphQL input type for assigning a Lot to a Location.
- AssignLotToLocationOutput — GraphQL output type for assigning a Lot to a Location.
- AuthenticatedUser
- Authorization
- AutoAssignPickLocationsInput
- BigInt — The `BigInt` scalar type represents non-fractional whole numeric values. `BigInt` is not constrained to 32-bit like the `Int` type and thus is a less compatible type.
- Bill
- BillConnection
- BillEdge — A Relay edge containing a `Bill` and its cursor.
- BillExports
- BillExportsConnection
- BillExportsEdge — A Relay edge containing a `BillExports` and its cursor.
- BillQueryResult
- BillingLaborUnit
- BillingPeriod
- BillsQueryResult
- BuildKitComponentInput
- BuildKitInput
- BulkMutationOutput
- BulkUpdateTagsInput
- CancelOrderInput
- CancelPurchaseOrderInput
- CancelPurchaseOrderOutput
- CarrierBox
- CarrierBoxConnection
- CarrierBoxEdge — A Relay edge containing a `CarrierBox` and its cursor.
- CarrierBoxQueryResult
- CarrierBoxesQueryResult
- Case
- ChangeOrderWarehouseInput
- ClearAssemblyComponentsInput
- ClearAssemblyComponentsOutput
- ClearKitInput
- ClearToteInput
- ClearToteOutput
- ClosePurchaseOrderInput
- ClosePurchaseOrderOutput
- CreateBillInput
- CreateBillOutput
- CreateCustomBoxInput
- CreateCustomBoxOutput
- CreateExchangeItem
- CreateInboundShipmentInput
- CreateInboundShipmentOutput
- CreateItemsCycleCountInput
- CreateLabelResourceInput
- CreateLicensePlateNumbersInput
- CreateLicensePlateNumbersOutput
- CreateLineItemInput
- CreateLocationInput
- CreateLocationsCycleCountInput
- CreateLotInput — GraphQL input type for Lot creation.
- CreateLotOutput — GraphQL output type for Lot creation.
- CreateOrderAddressInput — Order type for addresses. Orders have addresses with more details than the rest of the system so we use our own types
- CreateOrderInput
- CreateProductCaseInput
- CreateProductImageInput
- CreateProductInput
- CreateProductOutput
- CreateProductVendorInput
- CreatePurchaseOrderAttachmentInput
- CreatePurchaseOrderInput
- CreatePurchaseOrderLineItemInput
- CreatePurchaseOrderOutput
- CreateRecountCycleCountInput
- CreateReturnExchangeInput
- CreateReturnExchangeOutput
- CreateReturnInput
- CreateReturnItemExchangeInput
- CreateReturnLineItemInput
- CreateReturnOutput
- CreateShipmentInput
- CreateShipmentLineItemInput
- CreateShipmentOutput
- CreateShipmentShippingLabelInput
- CreateShippingContainerInput
- CreateShippingContainersOutput
- CreateShippingLabelInput
- CreateShippingLabelOutput
- CreateShippingLinesInput
- CreateShippingPlanInput
- CreateShippingPlanOutput
- CreateToteInput
- CreateToteOutput
- CreateVendorInput
- CreateVendorOutput
- CreateWarehouseProductInput
- CreateWebhookInput
- CreateWebhookOutput
- CreateWholesaleLineItemInput
- CreateWholesaleOrderInput
- CreateWorkOrderInput
- CurrentUserQueryResult
- CustomBox
- CustomBoxConnection
- CustomBoxEdge — A Relay edge containing a `CustomBox` and its cursor.
- CustomBoxQueryResult
- CustomBoxesQueryResult
- CustomersWebhookHealth — An enumeration.
- CycleCountBatch
- CycleCountBatchConnection
- CycleCountBatchEdge — A Relay edge containing a `CycleCountBatch` and its cursor.
- CycleCountOutput
- CycleCountProgressType
- CycleCountQueryResult
- CycleCountsQueryResult
- DSCycleCountBatchCountTypes — An enumeration.
- DSCycleCountBatchQueueStatusTypes — An enumeration.
- DataExportFile
- DataExportType — Type of data export this file belongs to.
- Date — The `Date` scalar type represents a Date value as specified by [iso8601](https://en.wikipedia.org/wiki/ISO_8601).
- DateTime — The `DateTime` scalar type represents a DateTime value as specified by [iso8601](https://en.wikipedia.org/wiki/ISO_8601).
- Decimal — The `Decimal` scalar type represents a python Decimal.
- DeleteBillInput
- DeleteCustomBoxInput
- DeleteCustomBoxOutput
- DeleteItemLocationInput
- DeleteItemLocationOutput
- DeleteLocationInput
- DeleteLocationOutput
- DeleteLotInput — GraphQL input type for Lot delete.
- DeleteLotOutput — GraphQL output type for Lot delete.
- DeleteProductImageInput
- DeleteProductImageOutput
- DeleteProductInput
- DeleteToteInput
- DeleteToteOutput
- DeleteVendorInput
- DeleteWarehouseProductInput
- DeleteWebhookInput
- Dimensions
- DimensionsInput
- DisableWebhookInput
- DisableWebhookOutput
- EnableWebhookInput
- EnableWebhookOutput
- EntityType
- ExclusionFiltersInput
- FbaInventory
- FeeCategoryTotal
- FeeCategoryTotalConnection
- FeeCategoryTotalEdge — A Relay edge containing a `FeeCategoryTotal` and its cursor.
- FulfillOrderInput
- FulfillWholesaleOrderInput
- FulfillmentInvoice
- FulfillmentInvoiceConnection
- FulfillmentInvoiceEdge — A Relay edge containing a `FulfillmentInvoice` and its cursor.
- FulfillmentInvoiceInboundShippingItem
- FulfillmentInvoiceInboundShippingItemConnection
- FulfillmentInvoiceInboundShippingItemEdge — A Relay edge containing a `FulfillmentInvoiceInboundShippingItem` and its cursor.
- FulfillmentInvoiceQueryResult
- FulfillmentInvoiceReturnFulfillmentItem
- FulfillmentInvoiceReturnFulfillmentItemConnection
- FulfillmentInvoiceReturnFulfillmentItemEdge — A Relay edge containing a `FulfillmentInvoiceReturnFulfillmentItem` and its cursor.
- FulfillmentInvoiceReturnItem
- FulfillmentInvoiceReturnItemConnection
- FulfillmentInvoiceReturnItemEdge — A Relay edge containing a `FulfillmentInvoiceReturnItem` and its cursor.
- FulfillmentInvoiceShippingItem
- FulfillmentInvoiceShippingItemConnection
- FulfillmentInvoiceShippingItemEdge — A Relay edge containing a `FulfillmentInvoiceShippingItem` and its cursor.
- FulfillmentInvoiceStorageItem
- FulfillmentInvoiceStorageItemConnection
- FulfillmentInvoiceStorageItemEdge — A Relay edge containing a `FulfillmentInvoiceStorageItem` and its cursor.
- FulfillmentInvoicesQueryResult
- GenericScalar — The `GenericScalar` scalar type represents a generic GraphQL scalar value that could be: String, Boolean, Int, Float, List or Object.
- HoldsInput
- HospitalAllocationType
- ISODateTime — A DateTime field type that understand ISO 8601 strings, besides datetime objects. It supports strings with and without times, as well as using T or space as delimiter Ex. - YYYY-mm-dd - YYYY-mm-dd HH:MM:SS - YYYY-mm-ddTHH:MM:SS
- InboundShipment
- InboundShipmentConnection
- InboundShipmentContainerSize — An enumeration.
- InboundShipmentEdge — A Relay edge containing a `InboundShipment` and its cursor.
- InboundShipmentImage
- InboundShipmentImagesQueryResult
- InboundShipmentLoad — An enumeration.
- InboundShipmentLocationSummaryData
- InboundShipmentLocationSummaryItem
- InboundShipmentLocationSummaryLocation
- InboundShipmentLocationSummaryQueryResult
- InboundShipmentQueryResult
- InboundShipmentShipment — An enumeration.
- InboundShipmentStatus — An enumeration.
- InboundShipmentSummaryBin
- InboundShipmentSummaryContent
- InboundShipmentSummaryData
- InboundShipmentSummaryInLPN
- InboundShipmentSummaryLPN
- InboundShipmentSummaryLPNContainer
- InboundShipmentSummaryLineItem
- InboundShipmentSummaryLot
- InboundShipmentSummaryProductInfo
- InboundShipmentSummaryQueryResult
- InboundShipmentSummaryStats
- InboundShipmentSummaryWorker
- InboundShipmentsQueryResult
- InventoryAbortSnapshotInput
- InventoryChange
- InventoryChangeConnection
- InventoryChangeEdge — A Relay edge containing a `InventoryChange` and its cursor.
- InventoryChangesQueryResult
- InventoryGenerateSnapshotInput
- InventorySnapshot
- InventorySnapshotConnection
- InventorySnapshotEdge — A Relay edge containing a `InventorySnapshot` and its cursor.
- InventorySnapshotOutput
- InventorySnapshotQueryResult
- InventorySnapshotsQueryResult
- InventorySyncBatchQueryResult
- InventorySyncBatchesQueryResult
- InventorySyncInput
- InventorySyncItemStatus
- InventorySyncItemStatusConnection
- InventorySyncItemStatusEdge — A Relay edge containing a `InventorySyncItemStatus` and its cursor.
- InventorySyncOutput
- InventorySyncRowsQueryResult
- InventorySyncStatus
- InventorySyncStatusConnection
- InventorySyncStatusEdge — A Relay edge containing a `InventorySyncStatus` and its cursor.
- ItemFilterInput
- ItemLocation
- ItemLocationConnection
- ItemLocationEdge — A Relay edge containing a `ItemLocation` and its cursor.
- ItemLocationsQueryResult
- JSONObjectScalar — Custom scalar type for JSON objects only. This field will serialize Python dict objects to JSON strings, and deserialize JSON strings to Python dict objects. It will accept None and empty strings, and otherwise ensure the JSON value is an object.
- KitComponent
- LabelResource
- LaborAssignedJobInfo
- LaborCurrentActivity
- LaborJob
- LaborJobEdge
- LaborJobPage — A pass-through page mirroring workforce_hero's getJobs connection.
- LaborJobReference
- LaborJobsResult
- LaborShift
- LaborShiftManagement
- LaborSpecialProject
- LaborUnit — An enumeration.
- LaborUnitConnection
- LaborUnitEdge — A Relay edge containing a `LaborUnit` and its cursor.
- LaborUnitsQueryResult
- LaborWorker
- LaborWorkerAlert
- LaborWorkerEdge
- LaborWorkerPage — A pass-through page mirroring workforce_hero's getWorkers connection.
- LaborWorkersResult
- LakeheroDataExport
- LakeheroDataExportQueryResult
- LastMileLabel
- LegacyId
- LegacyIdQueryResult
- LicensePlateNumber
- LicensePlateNumberConnection
- LicensePlateNumberEdge — A Relay edge containing a `LicensePlateNumber` and its cursor.
- LicensePlateNumberV2
- LicensePlateNumberV2ContainerType — An enumeration.
- LicensePlateNumberV2Status — An enumeration.
- LineItem
- LineItemInput
- LineItemQuerySpecConnection
- LineItemQuerySpecEdge — A Relay edge containing a `LineItemQuerySpec` and its cursor.
- LineItemSerialNumber
- Location
- LocationConnection
- LocationEdge — A Relay edge containing a `Location` and its cursor.
- LocationOutput
- LocationQueryResult
- LocationType
- LocationsQueryResult
- Lot
- LotConnection
- LotEdge — A Relay edge containing a `Lot` and its cursor.
- LotsQueryResult
- MergeOrdersInput — Merge Orders Input
- MergeOrdersOutput — Merge Orders Output
- MergeableOrder
- MergeableOrderConnection
- MergeableOrderEdge — A Relay edge containing a `MergeableOrder` and its cursor.
- MergeableOrdersQueryResult
- MergedOrder
- MissingAllocationType
- Money
- MutationOutput
- Node — An object with an ID
- OperationError
- Order
- OrderAddAttachmentInput
- OrderAddAttachmentOutput
- OrderAddress — Order type for addresses. Orders have addresses with more details than the rest of the system so we use our own types
- OrderAttachment
- OrderAttachmentQuerySpecConnection
- OrderAttachmentQuerySpecEdge — A Relay edge containing a `OrderAttachmentQuerySpec` and its cursor.
- OrderConnection
- OrderEdge — A Relay edge containing a `Order` and its cursor.
- OrderHistory
- OrderHistoryConnection
- OrderHistoryEdge — A Relay edge containing a `OrderHistory` and its cursor.
- OrderHistoryQueryResult
- OrderHolds
- OrderLineItemAllocation
- OrderMutationOutput
- OrderNoteAttributeInput
- OrderQueryResult
- OrderShipmentMutationOutput
- OrderThirdPartyShipper
- OrderWarehouseAllocation
- OrdersQueryResult
- Package
- PackageConnection
- PackageEdge — A Relay edge containing a `Package` and its cursor.
- PackageInput
- PackageLineItemInput
- PackerPerformanceEdge
- PackerPerformancePage — A pass-through page mirroring workforce_hero's getPackingStats connection.
- PackerPerformanceStats — A row of packing performance for a single worker, sourced from workforce_hero.
- PackersPerformanceDashboardResult
- PacksPerDayQueryResult
- PageInfo — The Relay compliant `PageInfo` type, containing data necessary to paginate this connection.
- PalletData
- Pick
- PickConnection
- PickEdge — A Relay edge containing a `Pick` and its cursor.
- PickerPerformanceEdge
- PickerPerformancePage — A pass-through page mirroring workforce_hero's getPickingStats connection.
- PickerPerformanceStats — A row of picking performance for a single worker, sourced from workforce_hero.
- PickersPerformanceDashboardResult
- PickingJobStatus — An enumeration.
- PicksPerDayQueryResult
- Product
- ProductConnection
- ProductEdge — A Relay edge containing a `Product` and its cursor.
- ProductImage
- ProductMutationOutput
- ProductQueryResult
- ProductVendor
- ProductsQueryResult
- PurchaseOrder
- PurchaseOrderAttachment
- PurchaseOrderAttachmentConnection
- PurchaseOrderAttachmentEdge — A Relay edge containing a `PurchaseOrderAttachment` and its cursor.
- PurchaseOrderConnection
- PurchaseOrderEdge — A Relay edge containing a `PurchaseOrder` and its cursor.
- PurchaseOrderLineItem
- PurchaseOrderLineItemConnection
- PurchaseOrderLineItemEdge — A Relay edge containing a `PurchaseOrderLineItem` and its cursor.
- PurchaseOrderQueryResult
- PurchaseOrderTrackingNumber
- PurchaseOrderTrackingNumberConnection
- PurchaseOrderTrackingNumberEdge — A Relay edge containing a `PurchaseOrderTrackingNumber` and its cursor.
- PurchaseOrdersQueryResult
- RMALabel
- RMALabelType
- RecalculateBillInput
- RecalculateBillOutput
- ReceiveReturnLineItemInput
- ReceiveReturnLineItemOutput
- RemoveAssemblyComponentsComponentInput
- RemoveAssemblyComponentsInput
- RemoveAssemblyComponentsOutput
- RemoveKitComponentInput
- RemoveKitComponentsInput
- RemoveLineItemsInput
- RemoveProductFromVendorInput
- RemoveShippingLabelFromShippingContainerInput
- RemoveShippingLabelFromShippingContainerOutput
- RemoveWorkOrderFeeInput
- ReplaceInventoryInput
- Return
- ReturnAttachment
- ReturnConnection
- ReturnEdge — A Relay edge containing a `Return` and its cursor.
- ReturnExchange
- ReturnExchangeItem
- ReturnExchangeQueryResult
- ReturnHistory
- ReturnLabelType
- ReturnLineItem
- ReturnQueryResult
- ReturnsQueryResult
- SetLineItemSkuInput
- SetPurchaseOrderFulfillmentStatusInput
- SetPurchaseOrderFulfillmentStatusOutput
- Shipment
- ShipmentConnection
- ShipmentEdge — A Relay edge containing a `Shipment` and its cursor.
- ShipmentLineItem
- ShipmentLineItemConnection
- ShipmentLineItemEdge — A Relay edge containing a `ShipmentLineItem` and its cursor.
- ShipmentQueryResult
- ShipmentsQueryResult
- ShippedLineItemInput
- ShippedLineItemLot
- ShippedPackagesInput
- ShippingContainer
- ShippingContainerConnection
- ShippingContainerEdge — A Relay edge containing a `ShippingContainer` and its cursor.
- ShippingContainerLabel
- ShippingContainerLabelConnection
- ShippingContainerLabelEdge — A Relay edge containing a `ShippingContainerLabel` and its cursor.
- ShippingContainerQueryResult
- ShippingContainersQueryResult
- ShippingLabel
- ShippingLabelConnection
- ShippingLabelEdge — A Relay edge containing a `ShippingLabel` and its cursor.
- ShippingLines
- ShippingPlan
- ShippingPlanLineItem
- ShippingPlanLineItemConnection
- ShippingPlanLineItemEdge — A Relay edge containing a `ShippingPlanLineItem` and its cursor.
- ShippingPlanPackage
- ShippingPlanPackageConnection
- ShippingPlanPackageEdge — A Relay edge containing a `ShippingPlanPackage` and its cursor.
- ShippingPlanPackageLineItem
- ShippingPlanPackageLineItemConnection
- ShippingPlanPackageLineItemEdge — A Relay edge containing a `ShippingPlanPackageLineItem` and its cursor.
- ShippingPlanPallet
- ShippingPlanPalletConnection
- ShippingPlanPalletEdge — A Relay edge containing a `ShippingPlanPallet` and its cursor.
- ShippingPlanQueryResult
- ShippingPlanTrackingNumber
- ShippingPlanTrackingNumberConnection
- ShippingPlanTrackingNumberEdge — A Relay edge containing a `ShippingPlanTrackingNumber` and its cursor.
- StagedInventoryItemType
- Store
- SubmitBillInput
- ThirdPartyShipperInput
- Tote
- ToteConnection
- ToteEdge — A Relay edge containing a `Tote` and its cursor.
- ToteHistory
- ToteHistoryConnection
- ToteHistoryEdge — A Relay edge containing a `ToteHistory` and its cursor.
- ToteHistoryQueryResult
- TotePick
- ToteQueryResult
- TotesQueryResult
- TransferInventoryInput
- TransferInventoryOutput
- TransferToteToLocationInput
- TransferToteToLocationOutput
- URL
- UnmergeOrdersInput — Unmerge Orders Input
- UnmergeOrdersOutput — Unmerge Orders Output
- UpdateAssemblyComponentsComponentInput
- UpdateAssemblyComponentsInput
- UpdateAssemblyComponentsOutput
- UpdateBillAdHocChargeInput
- UpdateBillAdHocChargeOutput
- UpdateBillInput
- UpdateCarrierBoxInput
- UpdateCarrierBoxOutput
- UpdateCustomBoxInput
- UpdateCustomBoxOutput
- UpdateFeeInputType
- UpdateInboundShipmentInput
- UpdateInboundShipmentOutput
- UpdateInventoryInput
- UpdateInventoryOutput
- UpdateLineItemInput
- UpdateLineItemsInput
- UpdateLocationInput
- UpdateLotInput — GraphQL input type for Lot update.
- UpdateLotOutput — GraphQL output type for Lot update.
- UpdateLotsInput — GraphQL input type for Lots update.
- UpdateLotsOutput — GraphQL output type for Lots update.
- UpdateOrderFulfillmentStatusInput
- UpdateOrderHoldsInput
- UpdateOrderInput
- UpdateOrderInputBase
- UpdateProductCaseInput
- UpdateProductImageInput
- UpdateProductInput
- UpdateProductVendorInput
- UpdatePurchaseOrderInput
- UpdatePurchaseOrderLineItemInput
- UpdatePurchaseOrderOutput
- UpdateReturnStatusInput
- UpdateReturnStatusOutput
- UpdateTagsInput
- UpdateToteInput
- UpdateToteOutput
- UpdateUrlWebhookInput
- UpdateUrlWebhookOutput
- UpdateUserInput
- UpdateUserOutput
- UpdateWarehouseProductInput
- UpdateWholesaleLineItemInput
- UpdateWholesaleOrderInput
- UpdateWholesaleOrderInputBase — Base class for all wholesale order update inputs, allowing users to reference the order by its ID or its associated order_id.
- UpdateWholesaleOrderPickingFlowInput
- UpdateWholesaleOrderStagingLocationInput
- UpdateWorkOrderFeeInput
- User
- UserConnection
- UserEdge — A Relay edge containing a `User` and its cursor.
- UserError — Base Interface all user-facing GraphQL errors should implement. This is used to provide a common way to handle errors in the frontend. A possible scenario would be having a create_user mutation that returns different types of error if the email is already in use, the password is too short, etc. It could be declared like this: ``` class UsernameTakenError(ObjectType): class Meta: interfaces = (UserError, ) suggestedUsernames = List(String) class PasswordTooShortError(ObjectType): class Meta: interfaces = (UserError, ) class UserCreationError(Union): class Meta: types = (UsernameTakenError, PasswordTooShortError) class CreateUser(Mutation): user = Field(User) errors = List(UserCreationError) ``` And it would be queried like this: ``` mutation { createUser(email: foo@bar.com, password: "123") { user { id } errors { __typename ... on UserError { message } ... on UsernameTakenError { message suggestedUsername } ... on PasswordTooShortError { message } } } } ``` If new errors are added, and they implement the UserError interface, the frontend will be able to handle at least the message field without any changes. based on: https://productionreadygraphql.com/2020-08-01-guide-to-graphql-errors
- UserNoteInput
- UserQueryResult
- UserQuota
- UsersQueryResult
- Vendor
- VendorConnection
- VendorEdge — A Relay edge containing a `Vendor` and its cursor.
- VendorsQueryResult
- Warehouse
- WarehouseProduct
- WarehouseProductConnection
- WarehouseProductEdge — A Relay edge containing a `WarehouseProduct` and its cursor.
- WarehouseProductInbound
- WarehouseProductInboundConnection
- WarehouseProductInboundEdge — A Relay edge containing a `WarehouseProductInbound` and its cursor.
- WarehouseProductMutationOutput
- WarehouseProductsQueryResult
- WarehouseRelationship
- Webhook
- WebhookCallLog
- WebhookCallLogEdge
- WebhookCallLogPage
- WebhookCallLogPageInfo
- WebhookConnection
- WebhookEdge — A Relay edge containing a `Webhook` and its cursor.
- WebhooksCallLogsQueryResult
- WebhooksQueryResult
- WholesaleFulfillmentFlowOptions — Allowed label formats
- WholesaleLineItem
- WholesaleLineItemsQuerySpecConnection
- WholesaleLineItemsQuerySpecEdge — A Relay edge containing a `WholesaleLineItemsQuerySpec` and its cursor.
- WholesaleLocationType — An enumeration.
- WholesaleOrder
- WholesaleOrderAutoAllocateForPickingMutationOutput
- WholesaleOrderAutoAllocateForPickingType
- WholesaleOrderAutoAllocateInput
- WholesaleOrderConnection
- WholesaleOrderEdge — A Relay edge containing a `WholesaleOrder` and its cursor.
- WholesaleOrderEditOutboundScheduleInput
- WholesaleOrderEditOutboundScheduleOutput
- WholesaleOrderGenerateBOLInput
- WholesaleOrderGenerateBOLOutput
- WholesaleOrderGenerateLabelsInput
- WholesaleOrderGenerateLabelsOutput
- WholesaleOrderImportPackingLayoutInput
- WholesaleOrderImportPackingLayoutOutput
- WholesaleOrderMarkAsPackedInput
- WholesaleOrderMarkAsPackedOutput
- WholesaleOrderMutationOutput
- WholesaleOrderOutboundProgress — An enumeration.
- WholesaleOrderPickingFlow — An enumeration.
- WholesaleOrderPrintLabelsInput
- WholesaleOrderPrintLabelsOutput
- WholesaleOrderPrintManualPickingSheetInput
- WholesaleOrderPrintManualPickingSheetOutput
- WholesaleOrderPrintPackingListInput
- WholesaleOrderPrintPackingListOutput
- WholesaleOrderPrintPackingSlipInput
- WholesaleOrderPrintPackingSlipOutput
- WholesaleOrderQueryResult
- WholesaleOrderSetReadyToPickInput
- WholesaleOrderSetReadyToPickOutput
- WholesaleOrderStatus — Overall status for the entire label generation workflow of an order accross all batches Public usage. Not to be confused with fulfillment status. The reason why this exists is due to reprocessing, there could be multiple print batches per order.
- WholesaleOrderVersion — The version of the order. This is used to determine which version of the wholesale view to display these orders in, amongst other things. The versioning is based on multiples of ten for the major and the integers between them as minors: 11 -> 1 1 | |__> Minor, in this case, Downgrade from EARTH to LEGACY |_____> Major, in this case, LEGACY
- WholesaleOrdersQueryResult
- WholesaleShippingDetails
- WholesaleShippingDetailsInput
- WholesaleShippingOptions — An enumeration.
- WholesaleSortBinByLotsDate — An enumeration.
- WholesaleSortBinByStock — An enumeration.
- WholesaleStagingLocationCandidatesQueryResult
- WorkOrderAssemblyComponentType
- WorkOrderAssemblySkuType
- WorkOrderAssignPickLocationsOutput
- WorkOrderAttachmentType
- WorkOrderFeeType
- WorkOrderIdentifiableType
- WorkOrderIdentifiableTypeConnection
- WorkOrderIdentifiableTypeEdge — A Relay edge containing a `WorkOrderIdentifiableType` and its cursor.
- WorkOrderMutationOutput
- WorkOrderNotesType
- WorkOrderPriority — An enumeration.
- WorkOrderQueryResult
- WorkOrderStatus — An enumeration.
- WorkOrderType — An enumeration.
- WorkOrdersNoteType — An enumeration.
- WorkOrdersQueryResult
- WorkforceHeroPageInfo — Cursor pagination metadata as returned by workforce_hero.