{"openapi":"3.1.0","info":{"title":"Shipmonk API","version":"v1.018"},"paths":{"/v1/integrations/receiving":{"get":{"operationId":"get-v1-integrations-receiving","parameters":[{"in":"query","name":"receivingKey","schema":{"type":["string","null"],"default":null},"required":false,"description":"Optional filter to retrieve a receiving by its external reference key (e.g. purchase order number) assigned by the client when the receiving was created. Returns the matching receiving or null if not found.","example":"key-123"},{"in":"query","name":"asn","schema":{"type":["string","null"],"default":null},"required":false,"description":"Optional filter to retrieve a receiving by its Advance Shipping Notice (ASN) number, a supplier-provided identifier for the incoming shipment.","example":"ASN-12345"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipMonk_OMS_Receiving_ApiResource_PublicApiReceivingOutput"}}}}},"tags":["Receivings"],"security":[{"api_key_header_Api-Key":[]}],"description":"## ASN & Receiving Key\nWhen retrieving a Receiving, you must supply either `receivingKey` or `asn` parameter.\n\n- In case both is supplied, they must both match a single Receiving.\n- Using only one of the parameters is strongly advised.\n\n## LineKey\n- When item objects are supplied with `line_key` string field, these items are then uniquely identified and can be referenced by it, if needed to change expected quantity.\n- Line Key must be unique per receiving.\n- Null/missing values are also expected. Such lines are then grouped by product and lot if supplied multiple times in the POST request.","summary":"Get Receiving"},"post":{"operationId":"post-v1-integrations-receiving","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Crate_ReceivingCreateOrUpdateOutput"}}}}},"tags":["Receivings"],"security":[{"api_key_header_Api-Key":[]}],"description":"## General description\n- ERP push to ShipMonk\n- `items.[].lot` or any of its property can be null\n\n## ASN & Receiving Key\n- When updating a Receiving, the identifying properties are `receiving_key` and `asn` in this order.\n  - In case both are supplied\n    - First, Receiving is retrieved by `receiving_key`. If found, it is updated with new ASN if current ASN is different than `asn` in the request body.\n    - If not found, Receiving is retrieved by `asn`. If found, it is updated with new `receiving_key` in the request body.\n    - If not found, new Receiving is created with `receiving_key` and asn being its unique identifiers.\n  - In case only asn is supplied\n    - First, Receiving is retrieved by `asn`. If found, `receiving_key` of the Receiving is left as-is as it cannot be deleted upon setting up.\n    - If not found, new Receiving is created with `asn` being its unique identifier.\n  - In case only `receiving_key` is supplied\n    - The request is rejected, as `asn` is required field.\n\n## LineKey\n- When item objects are supplied with `line_key` string field, these items are then uniquely identified and can be referenced by it, if needed to change expected quantity.\n- Line Key must be unique per receiving.\n- Null/missing values are also expected. Such lines are then grouped by product and lot if supplied multiple times in the POST request.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Receiving_ReceivingCreateOrUpdate_CreateOrUpdateReceivingInput"}}}},"summary":"Create or Update Receiving"}},"/v1/integrations/returns":{"get":{"operationId":"get-v1-integrations-returns","parameters":[{"in":"query","name":"rma","schema":{"type":"string","maxLength":255,"pattern":"\\S"},"required":true,"description":"Return Merchandise Authorization (RMA) number used to look up the return; optional query filter."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_ReturnOutput"}}}}},"tags":["Returns"],"security":[{"api_key_header_Api-Key":[]}],"description":"DEPRECATED – please use Retrieve List of Returns instead with filter for RMA.","deprecated":true,"summary":"Get Return"},"post":{"operationId":"post-v1-integrations-returns","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"data":{"type":"object","properties":{"message":{"type":"string"},"id":{"type":"integer"}},"required":["message","id"]}},"required":["status","data"]}}}}},"tags":["Returns"],"security":[{"api_key_header_Api-Key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_ReturnInput"}}}},"summary":"Create or Update Return"}},"/v1/integrations/order":{"post":{"operationId":"post-v1-integrations-order","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Crate_OrderSyncOutput"}}}}},"tags":["Orders"],"security":[{"api_key_header_Api-Key":[]}],"description":"This endpoint can be used to create an order. The orders are typically pushed to ShipMonk from the 3rd party software.\n\nThe Create Order endpoint does not create duplicate entries when both the `store_id` and `order_key` are the same. Instead, it updates the existing order.\n\n*NOTE: Resending an Order with a different `order_key` will result in Order duplication.**\n\nThe order can be in following 4 statuses:\n- `unfulfilled` will create order for ShipMonk to process\n- `cancelled` will create cancelled order or cancel existing order\n- `fulfilled` will create order in status \"Fulfilled by 3rd party\" or change existing order status to that status or not perform any action if order was fulfilled by ShipMonk\n- `onHold` will create order in status onHold or put an existing order on hold.\n\nCan be useful:\n- if the field `warehouse` is not given, ShipMonk resolves it based on inventory & shipping costs\n- the field `custom_data` can be used for any data that you need to store and then receive back in shipment notification\n- the field `attributes` is only used for a custom development and in most of the cases it won't be needed\n- if the field submit_at is not given, order is submit according to store settings.\n\n## Recipient Tax ID\nThe **recipient_tax_id** field is an optional parameter when submitting an order through the API. However, it is **mandatory** for international shipments to certain countries, such as Mexico, Brazil, and South Korea. This field plays a role in customs clearance, ensuring accurate calculation of duties and taxes at the destination.\n\n### How it's used\nFor orders shipping to destinations where a recipient tax ID is mandatory, failure to include this field on the shipping label will result in the order being placed in the **\"Recipient Tax ID Required\" Action Required status**. Without a valid tax ID, carriers may reject the shipment, returning it to the sender.\n\n### Best Practices\nTo prevent delays, collect the `recipient_tax_id` from the recipient at checkout. This information is unique to the individual or entity receiving the shipment.\n\n### Resolving Missing Recipient Tax ID Issues\nTo address a missing recipient tax ID, you can update the `recipient_tax_id` in one of two ways:\n- **Via API**: Submit the missing tax ID programmatically using the appropriate endpoint.\n- **Manually**: Edit the order details directly in the ShipMonk App.\n\nAdditional Resources\nFor more information, including a current list of countries requiring a recipient tax ID, consult the [Action Required Orders](https://support.shipmonk.com/s/article/Action-Required-Orders) documentation. Refer specifically to the **\"Recipient Tax ID Required\"** section for detailed guidance and troubleshooting steps.\n\n## Lot requirements\nSettings for lot requirements (lot, minimum shelf life, etc.) depend on your account settings. Contact your happiness manager to enable lot management.\n\nIt is possible to set minimum shelf life for the whole order, per order item, or specific lot requirements per order item.\n- If you set the minimum shelf life for the whole order, you can't use settings at the item level.\n- If you set the minimum shelf life for an order item, you can't set specific lot controls for the same order item.\n\nIf the lot requirement is not applicable to the mapped bundle, the order is accepted, but the item mapping ends with action required and you have to update the bundles or set different lot requirements.\n\nYou can override the requirements from public API manually in the application. New request from API will override the manual settings, also empty lot settings will remove existing lot restrictions.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderInput"}}}},"summary":"Create or Update Order"}},"/v1/integrations/orders":{"get":{"operationId":"get-v1-integrations-orders","parameters":[{"in":"query","name":"orderKey","schema":{"type":["string","null"],"minLength":1,"maxLength":255,"default":null},"required":false,"description":"Filter by the external system's unique order identifier (order_key). Returns only orders matching this value; omit to skip this filter.","example":"327b5abd-017a-4504-a50d-54f1cea80269"},{"in":"query","name":"orderNumber","schema":{"type":["string","null"],"minLength":1,"maxLength":255,"default":null},"required":false,"description":"Filter by the customer-facing order identifier (order_number). Returns only orders matching this value; omit to skip this filter.","example":"Order-123"},{"in":"query","name":"storeId","schema":{"type":["integer","null"],"minimum":1,"default":null},"required":false,"description":"Filter by the internal numeric identifier of the store that owns the order. Omit to return orders across all stores.","example":123456}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"data":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderDetailOutput"}},"required":["status","data"]}}}}},"tags":["Orders"],"security":[{"api_key_header_Api-Key":[]}],"description":"This endpoint can be used to retrieve data from the order you are calling.The order can be in following 4 statuses (field order_status):\n- `unfulfilled` indicates an order is ready for ShipMonk to process\n- `cancelled` indicates an order was cancelled\n- `fulfilled` indicates an order has been marked as \"Fulfilled by 3rd party\", unless already fulfilled by ShipMonk\n- `onHold` indicates an order is placed on hold\n\nYou can retrieve orders from all of your stores. In case you have not unique orderKeys across stores you can specify the storeId.","summary":"Get Order"}},"/v1/integrations/orders-list":{"get":{"operationId":"get-v1-integrations-orders-list","parameters":[{"in":"query","name":"page","schema":{"type":"integer","minimum":1,"default":1},"required":false,"description":"1-based page number to return. Defaults to 1.","example":1},{"in":"query","name":"pageSize","schema":{"type":"integer","minimum":1,"maximum":100,"default":100},"required":false,"description":"Number of results per page. Defaults to a server-configured value; check the response metadata for the effective size.","example":10},{"in":"query","name":"sortOrder","schema":{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_Enum_PublicApiOrdering","default":"ASC"},"required":false,"description":"Sort direction by internal order id: DESC (newest first) or ASC (oldest first)."},{"in":"query","name":"orderKeys","schema":{"type":["array","null"],"items":{"type":"string","minLength":1,"maxLength":255},"default":null},"required":false,"description":"Filter to orders whose order_key matches any value in this list."},{"in":"query","name":"orderNumbers","schema":{"type":["array","null"],"items":{"type":"string","minLength":1,"maxLength":255},"default":null},"required":false,"description":"Filter to orders whose order_number matches any value in this list."},{"in":"query","name":"orderStatus","schema":{"anyOf":[{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_Enum_PublicApiOrderStatus"},{"type":"null"}],"default":null},"required":false,"description":"Filter by current order status (see PublicApiOrderStatus enum); omit to return all statuses."},{"in":"query","name":"orderType","schema":{"anyOf":[{"$ref":"#/components/schemas/ShipMonk_OMS_Order_Enum_OrderType"},{"type":"null"}],"default":null},"required":false,"description":"Filter by order type (see OrderType enum); omit to return all types."},{"in":"query","name":"updatedAtStart","schema":{"type":"string","format":"date-time","default":null},"required":false,"description":"Lower bound (inclusive) on updated_at as an ISO 8601 timestamp; returns orders updated at or after this time.","example":"2025-07-24 14:53:00"},{"in":"query","name":"updatedAtEnd","schema":{"type":"string","format":"date-time","default":null},"required":false,"description":"Upper bound (inclusive) on updated_at as an ISO 8601 timestamp; returns orders updated at or before this time.","example":"2025-07-24 14:53:00"},{"in":"query","name":"shippedAtStart","schema":{"type":"string","format":"date-time","default":null},"required":false,"description":"Lower bound (inclusive) on shipped_at as an ISO 8601 timestamp; returns orders shipped at or after this time.","example":"2025-07-24 14:53:00"},{"in":"query","name":"shippedAtEnd","schema":{"type":"string","format":"date-time","default":null},"required":false,"description":"Upper bound (inclusive) on shipped_at as an ISO 8601 timestamp; returns orders shipped at or before this time.","example":"2025-07-24 14:53:00"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"data":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderList_PublicApiOrderListOutput"}},"required":["status","data"]}}}}},"tags":["Orders"],"security":[{"api_key_header_Api-Key":[]}],"description":"When no filters are specified, the endpoint will return up to the first 1,000,000 orders, based on selected ordering. If filters are used, this endpoint will return a maximum of 10,000 orders.","summary":"Retrieve List of Orders"}},"/v1/integrations/product":{"post":{"operationId":"post-v1-integrations-product","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"data":{"$ref":"#/components/schemas/Fulfillment_AccountApiBundle_ApiResource_MessageOutput"}},"required":["status","data"]}}}}},"tags":["Products"],"security":[{"api_key_header_Api-Key":[]}],"description":"- ERP push to ShipMonk\n- ShipMonk will ensure that only single Product with matching SKU exists and will reject repeated requests.\n\n- Possible values for required_packaging\n  - `poly_mailer`, `bubble_mailer`, `box`, `slap_a_label`\n  - ShipMonk will use this field to resolve lowest level of packaging for orders.\n- Field `country_of_origin` will accept 2 letter ISO 3166-1-alpha2 country code\n- Updates to products will be made directly in ShipMonk UI\n\n## Fragile products\nIf you mark product as fragile, the selected packaging must be `box`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Product_ProductCreate_CreateProductInput"}}}},"summary":"Create Product"}},"/v1/integrations/products/search":{"post":{"operationId":"post-v1-integrations-products-search","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_ApiResource_Product_ProductSearchOutput"}}}}},"tags":["Products"],"security":[{"api_key_header_Api-Key":[]}],"description":"Search for products based on a set of filters and sorting criteria. A cursor is returned that can be used by /integrations/products/search/paginate endpoint to iterate through the results.\n\nThe search results are fixed at the time of the request. This guarantees that it's possible to iterate over the whole data set reliably without missing any products.\nThe returned cursor is valid for 1 hour.\n\nA typical use-case might be inventory synchronization where products with updated inventory are fetched periodically, (for example fetching changes from the previous day 8am up until now).\nWith the search results being fixed, the synchronization process can be implemented in a reliable way.\nOne thing to note, the inventory_on_hand_last_updated_at field only captures the latest update so when a product was first updated the day before and then again on the current day, it will not be included in the results for yesterday only.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_Input_SearchProductsInput"}}}},"summary":"Products for Inventory Sync"}},"/v1/integrations/products/search/paginate":{"get":{"operationId":"get-v1-integrations-products-search-paginate","parameters":[{"in":"query","name":"cursor","schema":{"type":"string","minLength":1,"maxLength":1024},"required":true,"description":"Cursor returned from the initial /integrations/products/search call, or the next_cursor value returned from a previous call to this endpoint."},{"in":"query","name":"pageSize","schema":{"type":"integer","minimum":1,"maximum":500,"default":50},"required":false,"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_ApiResource_Product_ProductSearchResultsOutput"}}}}},"tags":["Products"],"security":[{"api_key_header_Api-Key":[]}],"description":"Iterate over results from /integrations/products/search endpoint using the returned cursor or using the cursor provided by response of this request as nextCursor.\n\nThe response is the same as the legacy /products endpoint (Retrieve List of Products).","summary":"Fetch results from Products for Inventory Sync"}},"/v1/integrations/receipts-list":{"get":{"operationId":"get-v1-integrations-receipts-list","parameters":[{"in":"query","name":"page","schema":{"type":"integer","minimum":1,"default":1},"required":false,"description":"1-based page number to return. Defaults to 1.","example":1},{"in":"query","name":"pageSize","schema":{"type":"integer","minimum":1,"maximum":100,"default":100},"required":false,"description":"Number of results per page. Defaults to a server-configured value; check the response metadata for the effective size.","example":10},{"in":"query","name":"sortOrder","schema":{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_Enum_PublicApiOrdering","default":"ASC"},"required":false,"description":"Sort direction for the results: ASC (ascending) or DESC (descending). Defaults to DESC."},{"in":"query","name":"asn","schema":{"type":["string","null"],"default":null},"required":false,"description":"Return only receipts whose Advance Ship Notice (ASN) number matches this value.","example":"ASN-12345"},{"in":"query","name":"warehouseId","schema":{"type":["integer","null"],"minimum":1,"default":null},"required":false,"description":"Return only receipts processed in the warehouse with this numeric identifier.","example":15},{"in":"query","name":"completedAt","schema":{"type":"string","format":"date-time","default":null},"required":false,"description":"Return only receipts completed at or after this ISO 8601 timestamp.","example":"2025-07-24 14:53:00"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"paginator":{"$ref":"#/components/schemas/ShipMonk_Api_Output_PaginatorOutput"},"status":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ShipMonk_OMS_Receiving_ApiResource_PublicApiReceivingReceiptOutput"}}},"required":["paginator","status","data"]}}}}},"tags":["Receivings"],"security":[{"api_key_header_Api-Key":[]}],"summary":"Retrieve List of Receipts"}},"/v1/integrations/receivings-list":{"get":{"operationId":"get-v1-integrations-receivings-list","parameters":[{"in":"query","name":"asn","schema":{"type":["string","null"],"minLength":1,"maxLength":255,"default":null},"required":false,"description":"Return only receivings whose Advance Ship Notice (ASN) number matches this value.","example":"ASN-12345"},{"in":"query","name":"warehouseId","schema":{"type":"string","default":null},"required":false,"description":"Short warehouse code (e.g., CA1, PA2) to filter receivings by. Note: this is a string code, not a numeric ID.","example":"PA1"},{"in":"query","name":"createdAt","schema":{"type":"string","format":"date-time","default":null},"required":false,"description":"Return only receivings created at or after this ISO 8601 timestamp.","example":"2025-07-24 14:53:00"},{"in":"query","name":"updatedAt","schema":{"type":"string","format":"date-time","default":null},"required":false,"description":"Return only receivings updated at or after this ISO 8601 timestamp.","example":"2025-07-24 14:53:00"},{"in":"query","name":"page","schema":{"type":"integer","minimum":1,"default":1},"required":false,"description":"1-based page number to return. Defaults to 1.","example":1},{"in":"query","name":"pageSize","schema":{"type":"integer","minimum":1,"maximum":100,"default":100},"required":false,"description":"Number of results per page. Defaults to a server-configured value; check the response metadata for the effective size.","example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"paginator":{"$ref":"#/components/schemas/ShipMonk_Api_Output_PaginatorOutput"},"status":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ShipMonk_OMS_Receiving_ApiResource_PublicApiReceivingOutput"}}},"required":["paginator","status","data"]}}}}},"tags":["Receivings"],"security":[{"api_key_header_Api-Key":[]}],"summary":"Retrieve List of Receivings"}},"/v1/integrations/returns-list":{"get":{"operationId":"get-v1-integrations-returns-list","parameters":[{"in":"query","name":"rma","schema":{"type":["string","null"],"maxLength":255,"pattern":"\\S","default":null},"required":false,"description":"Return only returns whose Return Merchandise Authorization (RMA) number matches this value."},{"in":"query","name":"return_status","schema":{"anyOf":[{"$ref":"#/components/schemas/ShipMonk_Warehouse_Returns_Enum_ReturnStatus"},{"type":"null"}],"default":null},"required":false,"description":"Return only returns currently in this status (e.g., pending, processing, completed)."},{"in":"query","name":"warehouse_id","schema":{"type":["integer","null"],"exclusiveMinimum":0,"default":null},"required":false,"description":"Numeric identifier of the warehouse processing the return; use the value returned by the warehouses endpoint."},{"in":"query","name":"return_reason","schema":{"anyOf":[{"$ref":"#/components/schemas/ShipMonk_Warehouse_Returns_Enum_ReturnReason"},{"type":"null"}],"default":null},"required":false,"description":"Return only returns flagged with this reason code (e.g., damaged, wrong_item, no_longer_needed)."},{"in":"query","name":"created_at","schema":{"type":"string","format":"date-time","default":null},"required":false,"description":"Return only returns created at or after this ISO 8601 timestamp.","example":"2025-07-24 14:53:00"},{"in":"query","name":"updated_at","schema":{"type":"string","format":"date-time","default":null},"required":false,"description":"Return only returns updated at or after this ISO 8601 timestamp.","example":"2025-07-24 14:53:00"},{"in":"query","name":"desired_action","schema":{"anyOf":[{"$ref":"#/components/schemas/ShipMonk_Warehouse_Returns_Enum_ReturnItemStatus"},{"type":"null"}],"default":null},"required":false,"description":"Return only returns whose items have this intended processing action (e.g., restock, dispose)."},{"in":"query","name":"page","schema":{"type":"integer","exclusiveMinimum":0,"default":1},"required":false,"description":"1-based page number to return. Defaults to 1.","example":1},{"in":"query","name":"page_size","schema":{"type":"integer","minimum":1,"maximum":100,"default":100},"required":false,"description":"Number of results per page (default and maximum values are documented at the endpoint level).","example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"paginator":{"$ref":"#/components/schemas/ShipMonk_Api_Output_PaginatorOutput"},"status":{"type":"integer"},"data":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Crate_ReturnsListPublicApiOutput"}},"required":["paginator","status","data"]}}}}},"tags":["Returns"],"security":[{"api_key_header_Api-Key":[]}],"summary":"Retrieve List of Returns"}},"/v1/integrations/sandbox/complete-order":{"post":{"operationId":"post-v1-integrations-sandbox-complete-order","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"}},"required":["status"]}}}}},"tags":["Orders"],"security":[{"api_key_header_Api-Key":[]}],"description":"This endpoint simulates warehouse shipment of an order on Sandbox environment. After the order is completed, we send a shipment notification if set. It can't be used in production!\n\nOrder must be valid and submitted (available inventory, valid address, valid shipping method).\n\nBy default there is 20 minutes delay between the order being shipped and the event of sending.\n\nFor D2C orders, there is up to 5 minutes (but almost about 1 minute) delay between order transition from awaiting pick up status and en route status. In this delay the webhook with awaiting shipment status is delivered to simulate real process.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Input_CompleteOrderInput"}}}},"summary":"Complete Order"}},"/v1/integrations/sandbox/complete-receiving":{"post":{"operationId":"post-v1-integrations-sandbox-complete-receiving","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"}},"required":["status"]}}}}},"tags":["Receivings"],"security":[{"api_key_header_Api-Key":[]}],"description":"This action is available only at Sandbox environment for testing purposes! It is not possible to complete order which is in the state Action Required.\n\nReceiving is proccessed and all items are received.\n\n## ASN & Receiving Key\n- When completing a Receiving, you must supply either `receiving_key` or `asn` parameter.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Input_ReceivingCompleteInput"}}}},"summary":"Complete Receiving"}},"/v1/integrations/sandbox/complete-return":{"post":{"operationId":"post-v1-integrations-sandbox-complete-return","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"}},"required":["status"]}}}}},"tags":["Returns"],"security":[{"api_key_header_Api-Key":[]}],"description":"This endpoint simulates the full return lifecycle on Sandbox environment. It can't be used in production!\n\nThe return goes through arrival, check-in, receiving, grading, and completion based on the specified completion mode and disposition.\n\n## Completion Modes\nCompletion mode changes how many units are received of the FIRST item in the return. Other items are always fully received.\n| Mode | Description | Constraint |\n|------|-------------|------------|\n| `fully_received` | Receives the complete expected quantity | None |\n| `short_received` | Receives one less unit than expected | Expected quantity must be greater than 1 |\n| `excess_received` | Receives one more unit than expected | None |\n| `partially_received` | Receives only 1 unit regardless of expected quantity | Expected quantity must be greater than 1 |\n\n## Dispositions\n\n| Disposition | Constraint |\n|-------------|------------|\n| `returned_to_inventory`| None |\n| `reworked` | Account must have rework feature enabled |\n| `dispose` | None |\n| `donate` | None |\n| `return_to_merchant` | None |","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Input_CompleteSandboxReturnInput"}}}},"summary":"Complete Return"}},"/v1/integrations/submit-order":{"post":{"operationId":"post-v1-integrations-submit-order","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"}},"required":["status"]}}}}},"tags":["Orders"],"security":[{"api_key_header_Api-Key":[]}],"description":"Orders in ShipMonk OMS may be submitted either manually or automatically based on the store settings. When the manual submission is chosen, the orders will go into `Queue to Submit` state and ShipMonk reserves inventory for such orders.\n\nThis endpoint sets the time when the order must be submitted for fulfilment (the fulfilment process may start rightaway).\n\nOrders can be submited in:\n - future - order will be queued and inventory reserved\n - past - order will be submited right now","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Input_SubmitOrderIntoQueueForFulfillmentAtDateInput"}}}},"summary":"Submit Order"}},"/v1/integrations/warehouses":{"get":{"operationId":"get-v1-integrations-warehouses","parameters":[{"in":"query","name":"page","schema":{"type":"integer","minimum":1,"maximum":1000,"default":1},"required":false,"description":"1-based page number to return. Defaults to 1.","example":1},{"in":"query","name":"pageSize","schema":{"type":"integer","minimum":1,"maximum":1000,"default":50},"required":false,"description":"Number of results per page. Defaults to a server-configured value; check the response metadata for the effective size.","example":10},{"in":"query","name":"sortBy","schema":{"anyOf":[{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_Enum_Warehouse_WarehouseListSortEnum"},{"type":"null"}],"default":null},"required":false,"description":"Field to sort warehouses by (e.g., id, name, identifier). See the schema for allowed values."},{"in":"query","name":"sortOrder","schema":{"anyOf":[{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_Enum_PublicApiOrdering"},{"type":"null"}],"default":null},"required":false,"description":"Sort direction: ASC (ascending) or DESC (descending)."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"paginator":{"$ref":"#/components/schemas/ShipMonk_Api_Output_PaginatorOutput"},"status":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_ApiResource_Warehouse_WarehouseListOutput"}}},"required":["paginator","status","data"]}}}}},"tags":["Warehouses"],"security":[{"api_key_header_Api-Key":[]}],"description":"Returns all usable warehouses for logged user.","summary":"Retrieve List of Warehouses"}},"/v1/products":{"get":{"operationId":"get-v1-products","parameters":[{"in":"query","name":"search","schema":{"type":["string","null"],"maxLength":255,"default":null},"required":false,"description":"Free-text filter matched against product SKU, name, or barcode.","example":"shirt"},{"in":"query","name":"page","schema":{"type":"integer","minimum":1,"default":1},"required":false,"description":"1-based page number to return. Defaults to 1.","example":1},{"in":"query","name":"pageSize","schema":{"type":"integer","minimum":1,"maximum":500,"default":50},"required":false,"description":"Number of products returned per page (default and maximum values are documented at the endpoint level).","example":10},{"in":"query","name":"sortBy","schema":{"type":["string","null"],"maxLength":255,"default":null},"required":false,"description":"Field to sort the results by; one of 'id', 'created_at', or 'updated_at'.","example":"id"},{"in":"query","name":"sortOrder","schema":{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_Enum_PublicApiOrdering","default":"ASC"},"required":false,"description":"Sort direction for the results: ASC (ascending) or DESC (descending). Defaults to DESC."},{"in":"query","name":"status","schema":{"anyOf":[{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_Enum_ProductStatusFilterEnum"},{"type":"null"}],"default":null},"required":false,"description":"Return only products in this status (e.g., active, inactive, discontinued). See the enum schema for the full list of allowed values."},{"in":"query","name":"dateUpdatedStart","schema":{"type":"string","format":"date-time","default":null},"required":false,"description":"Return only products updated at or after this ISO 8601 timestamp.","example":"2025-07-24 14:53:00"},{"in":"query","name":"dateUpdatedEnd","schema":{"type":"string","format":"date-time","default":null},"required":false,"description":"Return only products updated at or before this ISO 8601 timestamp.","example":"2025-07-24 14:53:00"},{"in":"query","name":"dateCreatedStart","schema":{"type":"string","format":"date-time","default":null},"required":false,"description":"Return only products created at or after this ISO 8601 timestamp.","example":"2025-07-24 14:53:00"},{"in":"query","name":"dateCreatedEnd","schema":{"type":"string","format":"date-time","default":null},"required":false,"description":"Return only products created at or before this ISO 8601 timestamp.","example":"2025-07-24 14:53:00"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_ApiResource_Product_ProductListOutput"}},"total":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"}},"required":["data","total","pages","page"]}}}}},"tags":["Products"],"security":[{"api_key_header_Api-Key":[]}],"description":"This endpoint doesn't guarantee the result set to be consistent between calls.\n\nIn other words, when filtering by dateUpdatedStart field, you might get product #123 on the first page and if enough products are updated in the meantime the same product can appear again on later requested page 2.\n\nIf you need consistent results, consider using Products for Inventory Sync endpoint instead.","summary":"Retrieve List of Products"}}},"components":{"schemas":{"Fulfillment_AccountApiBundle_ApiResource_MessageOutput":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"Message Output"},"Fulfillment_AccountApiBundle_Input_Order_CreateUpdateFulfillmentRequirements_SpecialRequirementsDatesInput":{"type":"object","properties":{"earliest":{"type":["string","null"],"format":"date","default":null},"requested":{"type":["string","null"],"format":"date","default":null},"latest":{"type":["string","null"],"format":"date","default":null}},"required":[],"title":"Special Requirements Dates Input"},"Fulfillment_AccountApiBundle_Input_Order_OrderReferenceInput":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Fulfillment_OrderBundle_Enum_OrderReferenceType"},"value":{"type":"string","pattern":"\\S"}},"required":["type","value"],"title":"Order Reference Input"},"Fulfillment_AccountApiBundle_Input_Return_ReferencesToRelatedOrderInput":{"type":"object","properties":{"order_number":{"description":"Order number to look up among existing orders' references; null disables the lookup.","type":["string","null"],"minLength":1,"example":"Order-123"},"search_in_all_stores":{"description":"When true, searches for the related order across all stores. When false, searches only within the store associated with the return.","type":"boolean"}},"required":["order_number","search_in_all_stores"],"title":"References To Related Order Input"},"Fulfillment_AccountApiBundle_Input_Return_ReturnIntegrationDataRecordInput":{"type":"object","properties":{"name":{"type":"string","minLength":3,"maxLength":255},"value":{"anyOf":[{"type":"object"},{"type":"null"}]}},"required":["name","value"],"title":"Return Integration Data Record Input"},"Fulfillment_AdminApiBundle_ApiResource_ProductHsCodeDetailOutput":{"type":"object","properties":{"hs_code":{"description":"Harmonized System code used for customs classification in international trade.","type":"string"},"region":{"description":"Region for which this HS code applies. Allowed values: us, uk, eu.","$ref":"#/components/schemas/ShipMonk_OMS_HsCode_Enum_HsCodeRegion"}},"required":["hs_code","region"],"title":"Product Hs Code Detail Output"},"Fulfillment_CommonBundle_ApiResource_IntegrationDataOutput":{"type":"object","properties":{"name":{"description":"Key of the custom data entry.","type":"string"},"value":{"description":"Value of the custom data entry; may be any JSON-serializable structure.","type":"object"}},"required":["name","value"],"title":"Integration Data Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_Enum_PublicApiOrderStatus":{"type":["string"],"enum":["unfulfilled","fulfilled","onHold","cancelled"],"title":"Order Status"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_OrderPackedItemOutput":{"type":"object","properties":{"sku":{"description":"Stock-keeping unit (SKU) of the order item that was packed.","type":"string"},"line_key":{"description":"Identifier of the order line this packed item refers to; null when the packed item is not tied to a specific line.","type":["string","null"]},"quantity":{"description":"Number of units of this SKU packed in this package.","type":"integer"}},"required":["sku","line_key","quantity"],"title":"Order Packed Item Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PackingGroupOutput":{"type":"object","properties":{"key":{"description":"Stable identifier of the packing group, unique within the order.","type":"string"},"name":{"description":"Human-readable name of the packing group; null if unnamed.","type":["string","null"]}},"required":["key","name"],"title":"Packing Group Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiAccountForTradingPartnerOutput":{"type":"object","properties":{"id":{"description":"Internal numeric identifier of the merchant account.","type":"integer"},"name":{"description":"Display name of the merchant account.","type":"string"}},"required":["id","name"],"title":"Account For Trading Partner Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiAccountTradingPartnerOutput":{"type":"object","properties":{"id":{"description":"Internal numeric identifier of the trading partner.","type":"integer"},"identifier":{"description":"Short human-readable code identifying the trading partner.","type":"string"},"name":{"description":"Display name of the trading partner.","type":"string"},"account":{"description":"Merchant account that owns this trading partner relationship.","$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiAccountForTradingPartnerOutput"}},"required":["id","identifier","name","account"],"title":"Account Trading Partner Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiCountryDetailOutput":{"type":"object","properties":{"code":{"description":"ISO 3166-1 alpha-2 country code; null if unknown.","type":["string","null"]},"name":{"description":"Country name in English; null if unknown.","type":["string","null"]}},"required":["code","name"],"title":"Country Detail Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiExtraDataOutput":{"type":"object","properties":{"label":{"description":"Identifier of the extra data type. Currently supported: carrierShippingMethod.","$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Enum_ShipmentNotificationExtraDataType"},"value":{"description":"Value corresponding to the label of the extra data entry.","type":"string"}},"required":["label","value"],"title":"Extra Data Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderActionsRequiredOutput":{"type":"object","properties":{"item_mapping":{"description":"True if one or more order items could not be mapped to a known product and require manual mapping.","type":"boolean"},"address":{"description":"True if the shipping address could not be validated and requires correction.","type":"boolean"},"shipping_mapping":{"description":"True if the requested shipping service could not be mapped to an available carrier service and requires manual mapping.","type":"boolean"},"customs":{"description":"True if customs information (e.g. declared value, HS codes) is missing or incomplete for an international shipment.","type":"boolean"},"at_risk":{"description":"True if the order is at risk of missing its required ship-by date.","type":"boolean"},"routing":{"description":"True if a B2B routing instruction is missing and must be supplied before shipping.","type":"boolean"},"freight_quote":{"description":"True if a freight quote must be selected before the order can ship.","type":"boolean"},"freight_info":{"description":"True if additional freight details (e.g. dimensions, pallet count) are required to obtain a freight quote.","type":"boolean"},"ship_short":{"description":"True if the order is flagged as a short ship, meaning one or more items could not be fulfilled in the requested quantity.","type":"boolean"},"hs_code":{"description":"True if Harmonized System (HS) tariff codes are missing for one or more items on a customs-bound shipment.","type":"boolean"},"global_e_label":{"description":"True if a Global-e label (cross-border shipping label provided by the Global-e service) is still required for the order.","type":"boolean"},"ship_monk_hazmat_carrier_service_not_available":{"description":"Deprecated: Will always be false, kept for backwards compatibility True if the order contains hazardous materials but no carrier service is available to ship them from the assigned warehouse.","deprecated":true,"type":"boolean"},"automation_rule":{"description":"True if an automation rule has flagged the order for manual review or action.","type":"boolean"},"pending_b2b_routing":{"description":"True if the order is awaiting B2B retailer routing instructions before fulfillment can proceed.","type":"boolean"},"value_added_service_problem":{"description":"True if one of the order's value-added services (e.g. kitting, custom packaging) cannot be performed and needs attention.","type":"boolean"}},"required":["item_mapping","address","shipping_mapping","customs","at_risk","routing","freight_quote","freight_info","ship_short","hs_code","global_e_label","ship_monk_hazmat_carrier_service_not_available","automation_rule","pending_b2b_routing","value_added_service_problem"],"title":"Order Actions Required Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderAttributeOutput":{"type":"object","properties":{"name":{"description":"Key of the custom attribute.","type":"string"},"value":{"description":"Value of the custom attribute.","type":"string"}},"required":["name","value"],"title":"Order Attribute Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderCostsOutput":{"type":"object","properties":{"estimated_shipping_related_charges":{"description":"Estimated shipping-related charges for the order. Null when no estimate is available.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_Money_Output_MoneyOutput"},{"type":"null"}]},"estimated_packaging_material_charges":{"description":"Estimated charges for packaging materials used in the order. Null when no estimate is available.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_Money_Output_MoneyOutput"},{"type":"null"}]},"estimated_pick_and_pack_charges":{"description":"Estimated charges for picking and packing labor for the order. Null when no estimate is available.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_Money_Output_MoneyOutput"},{"type":"null"}]}},"required":["estimated_shipping_related_charges","estimated_packaging_material_charges","estimated_pick_and_pack_charges"],"title":"Order Costs Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderDetailCustomDataOutput":{"type":"object","properties":{"name":{"description":"Key name of the custom data entry.","type":"string"},"value":{"description":"Value of the custom data entry.","type":"string"}},"required":["name","value"],"title":"Order Detail Custom Data Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderDetailOutput":{"type":"object","properties":{"order_key":{"description":"Unique identifier from an external system used to associate an order. Must be unique per order and store.","type":"string"},"order_number":{"description":"Customer-facing identifier for an order. Uniqueness is recommended but not strictly enforced.","type":"string"},"order_type":{"description":"Order classification (e.g. standard, wholesale, return). Null when not categorized.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_OMS_Order_Enum_OrderType"},{"type":"null"}]},"store":{"description":"Sales channel or storefront the order originated from.","$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiStoreNameOutput"},"warehouse":{"description":"Warehouse where the order is processed. Null if a warehouse has not yet been assigned.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiWarehouseDetailOutput"},{"type":"null"}]},"trading_partner":{"description":"B2B trading partner (e.g. retailer or distributor) the order is destined for. Null for direct-to-consumer orders.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiAccountTradingPartnerOutput"},{"type":"null"}]},"ordered_at":{"description":"ISO 8601 timestamp indicating when the order was originally placed.","type":"string","format":"date-time"},"customer_email":{"description":"Customer's email address. Null when not provided by the source system.","anyOf":[{"type":"string"},{"type":"null"}]},"shipping_method":{"description":"Carrier and service selected to ship the order. Null if no method has been resolved yet.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_ApiResource_ShippingMethod_PublicApiShippingMethodDetailOutput"},{"type":"null"}]},"requested_shipping_service":{"description":"Free-text shipping service originally requested by the customer or source system; null if none was specified.","type":["string","null"]},"shipping_paid":{"description":"Amount the customer paid for shipping, expressed in the order's currency_code.","type":"number","format":"double"},"tax_paid":{"description":"Amount the customer paid in taxes, expressed in the order's currency_code.","type":"number","format":"double"},"order_costs":{"description":"Estimated fulfillment-service charges (shipping, packaging, pick & pack) for the order. These are estimates and may differ from final billed amounts.","$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderCostsOutput"},"ship_from":{"description":"Origin address from which the order will ship. Null when not yet determined.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiShippingOrderDetailAddressOutput"},{"type":"null"}]},"ship_to":{"description":"Destination address the order will be shipped to. Null when not yet specified.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiShippingOrderDetailAddressOutput"},{"type":"null"}]},"order_status":{"description":"High-level order state: unfulfilled (not yet shipped), fulfilled (shipped), onHold (paused), cancelled.","$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_Enum_PublicApiOrderStatus"},"processing_status":{"description":"Fine-grained processing stage of the order. Values: backorder, unable_to_submit, queued_to_submit, subscription, package_forwarding, awaiting_label_request_from_merchant_facility, on_hold, submitted, pick_in_progress, pack_in_progress, packed, awaiting_pick_up, awaiting_carrier_processing, en_route, delivered, undeliverable, shipped_untrackable, fulfilled_by_3rd, cancellation_requested, cancelled, updating.","$ref":"#/components/schemas/Fulfillment_OrderBundle_Enum_OrderListStatus"},"items":{"description":"Line items (SKUs and quantities) included in the order.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderItemOutput"}},"attributes":{"description":"Custom key/value attributes attached to the order by the merchant or source system.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderAttributeOutput"}},"currency_code":{"description":"ISO 4217 currency code used for all monetary values on the order.","type":"string"},"references":{"description":"Additional external reference identifiers attached to the order (e.g. PO number, marketplace reference).","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderReferenceOutput"}},"custom_data":{"description":"Custom key-value data associated with the order.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderDetailCustomDataOutput"}},"special_requirements":{"description":"Special handling requirements for the order, such as required documents, label dates, and pack list rules. Null when none apply.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiSpecialRequirementsOutput"},{"type":"null"}]},"actions_required":{"description":"Boolean flags indicating issues that must be resolved before the order can be fulfilled.","$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderActionsRequiredOutput"},"master_tracking_number":{"description":"Master tracking number that groups all packages of a multi-piece shipment; null when not applicable.","type":["string","null"]},"tracking_url":{"description":"Carrier URL where the customer can track the shipment; null if not yet available.","type":["string","null"]},"returns":{"description":"Return Merchandise Authorizations (RMAs) created for this order.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderReturnDataOutput"}},"packages":{"description":"Per-package fulfillment data, including tracking numbers, weights, and packed contents.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderPackageDataOutput"}},"tax_id":{"description":"Deprecated: Use recipientTaxId Deprecated; use recipient_tax_id instead. Tax identifier associated with the recipient.","deprecated":true,"anyOf":[{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_ApiResource_Order_PublicApiOrderTaxIdOutput"},{"type":"null"}]},"recipient_tax_id":{"description":"Recipient tax identification (e.g. VAT or EIN); null when not provided. Used for customs clearance on international shipments.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_ApiResource_Order_PublicApiOrderTaxIdOutput"},{"type":"null"}]},"shipment_data":{"description":"Carrier and tracking details once the order has shipped; null until shipment data is available.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiShipmentDataOutput"},{"type":"null"}]},"order_parts":{"description":"Information about related orders when an order has been split into multiple parts; null if the order was not split.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderPartOutput"},{"type":"null"}]},"shipped_at":{"description":"ISO 8601 timestamp of when the order was shipped; null if not yet shipped.","type":["string","null"],"format":"date-time"},"updated_at":{"description":"ISO 8601 timestamp of when the order was last updated; null if never updated since creation.","type":["string","null"],"format":"date-time"},"order_size":{"description":"Size classification of the order based on item dimensions: unknown, regular, oversized_item, large, or extra_large.","$ref":"#/components/schemas/Fulfillment_OrderBundle_Enum_OrderSize"},"extra_data":{"description":"Additional key/value attributes attached to the shipment notification (e.g. carrier shipping method).","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiExtraDataOutput"}},"serial_numbers":{"description":"Serial numbers of items fulfilled in the order, grouped by order line.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiSerialNumberOutput"}},"gift_message":{"description":"Gift message to include with the order; null if the order is not a gift.","type":["string","null"]},"gift_from":{"description":"Name of the gift sender; null if the order is not a gift.","type":["string","null"]},"customer_notes":{"description":"Customer-provided notes about the order; null if no notes were submitted.","type":["string","null"]},"order_detail_url":{"description":"URL to view the order in the ShipMonk web application (requires sign-in).","type":"string"}},"required":["order_key","order_number","order_type","store","warehouse","trading_partner","ordered_at","customer_email","shipping_method","requested_shipping_service","shipping_paid","tax_paid","order_costs","ship_from","ship_to","order_status","processing_status","items","attributes","currency_code","references","custom_data","special_requirements","actions_required","master_tracking_number","tracking_url","returns","packages","tax_id","recipient_tax_id","shipment_data","order_parts","shipped_at","updated_at","order_size","extra_data","serial_numbers","gift_message","gift_from","customer_notes","order_detail_url"],"title":"Order Detail Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderItemOutput":{"type":"object","properties":{"line_key":{"description":"External system identifier for this order line, unique within the order. Null when not provided.","type":["string","null"]},"sku":{"description":"Stock Keeping Unit (SKU) identifying the marketplace item being ordered.","type":"string"},"name":{"description":"Display name of the marketplace item as captured on the order line.","type":["string","null"]},"quantity":{"description":"Number of units of this SKU ordered.","type":"integer"},"price":{"description":"Per-unit price charged to the customer, in the order's currency_code. Null when not provided.","type":["number","null"],"format":"double"},"image_url":{"description":"Absolute URL of the marketplace item image, if available.","type":["string","null"]},"fulfilled_quantity":{"description":"Number of units already shipped (fulfilled) for this line. Null if fulfillment has not started.","type":["integer","null"]},"source":{"description":"How this line was added to the order: imported (from the source channel), manual (added by a user), inserted (system-inserted, e.g. promo), packaging (added as packaging material), claim_reship (added as part of a claim reship).","$ref":"#/components/schemas/Fulfillment_OrderBundle_Enum_OrderItemSource"},"products":{"description":"Physical products allocated to fulfill this order line. A line with a bundle SKU may resolve to multiple component products.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderItemProductOutput"}}},"required":["line_key","sku","name","quantity","price","image_url","fulfilled_quantity","source","products"],"title":"Order Item Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderItemProductLotOutput":{"type":"object","properties":{"number":{"description":"Lot (batch) number assigned to the product. Null when the lot has no number recorded.","type":["string","null"]},"expiration_date":{"description":"Lot expiration date in ISO 8601 format (YYYY-MM-DD), or null if not applicable.","type":["string","null"],"format":"date"}},"required":["number","expiration_date"],"title":"Order Item Product Lot Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderItemProductOutput":{"type":"object","properties":{"sku":{"description":"Stock Keeping Unit (SKU) identifying the product being ordered.","type":"string"},"quantity":{"description":"Number of units of this physical product allocated to the order line.","type":"integer"},"backordered_quantity":{"description":"Number of units of this product that could not be allocated because of insufficient stock.","type":"integer"},"lot":{"description":"Inventory lot (batch) selected for this product. Null when the product is not lot-tracked or no lot has been assigned yet.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderItemProductLotOutput"},{"type":"null"}]},"other_potential_lots":{"description":"Other inventory lots that could alternatively be used to fulfill this product.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderItemProductLotOutput"}}},"required":["sku","quantity","backordered_quantity","lot","other_potential_lots"],"title":"Order Item Product Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderList_PublicApiOrderListOutput":{"type":"object","properties":{"orders":{"description":"Orders matching the request criteria for the current page.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderDetailOutput"}}},"required":["orders"],"title":"Order List Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderPackageDataOutput":{"type":"object","properties":{"number":{"description":"Sequential index (1-based) of this package within the order; null if not assigned.","type":["integer","null"]},"tracking_number":{"description":"Carrier tracking number for this package; null if not yet generated or untrackable.","type":["string","null"]},"tracking_url":{"description":"Carrier URL for tracking this package; null if not yet available.","type":["string","null"]},"weight_lb":{"description":"Total weight of the package (the unit, despite the field name, is provided in the value object); null if not measured.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_Measurement_Output_WeightOutput"},{"type":"null"}]},"pallet_weight_lb":{"description":"Weight of the pallet on which this package is shipped (unit given inside the value object); null if not palletized or not measured.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_Measurement_Output_WeightOutput"},{"type":"null"}]},"pallet_number":{"description":"Index (1-based) of the pallet that contains this package; null if not palletized.","type":["integer","null"]},"box_number":{"description":"Index (1-based) of the box within its pallet; null if not palletized.","type":["integer","null"]},"carton_labels":{"description":"Carton-level labels (e.g. packing slip, pallet label) applied to this package.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiPackageCartonLabelOutput"}},"packed_products":{"description":"Products contained in this package, aggregated by SKU with packed quantities and lot details.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiPackedProductOutput"}},"packing_group":{"description":"Packing group this package belongs to, used to split an order across multiple shipments; null if not grouped.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PackingGroupOutput"},{"type":"null"}]},"packed_items":{"description":"Order line items packed in this package, with per-line quantities.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_OrderPackedItemOutput"}}},"required":["number","tracking_number","tracking_url","weight_lb","pallet_weight_lb","pallet_number","box_number","carton_labels","packed_products","packing_group","packed_items"],"title":"Order Package Data Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderPartItemOutput":{"type":"object","properties":{"order_number":{"description":"Order number of this part order.","type":"string"}},"required":["order_number"],"title":"Order Part Item Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderPartMainOrderOutput":{"type":"object","properties":{"order_number":{"description":"Order number of the main order this part was split from.","type":"string"},"parts":{"description":"List of all part orders created from splitting the main order.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderPartItemOutput"}}},"required":["order_number","parts"],"title":"Order Part Main Order Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderPartOutput":{"type":"object","properties":{"main_order":{"description":"Reference to the original (main) order from which this order was split.","$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderPartMainOrderOutput"}},"required":["main_order"],"title":"Order Part Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderReferenceOutput":{"type":"object","properties":{"type":{"description":"Type of order reference. One of: order_number, original_imported_order_number, customer_order_number, po_number, reference_number, b2b_routing_reference, release_number, job_number, depositor_order_number.","$ref":"#/components/schemas/Fulfillment_OrderBundle_Enum_OrderReferenceType"},"value":{"description":"The reference identifier value, interpreted according to type.","type":"string"}},"required":["type","value"],"title":"Order Reference Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderReturnDataOutput":{"type":"object","properties":{"rma":{"description":"Return Merchandise Authorization (RMA) number identifying this return.","type":"string"}},"required":["rma"],"title":"Order Return Data Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiPackageCartonLabelOutput":{"type":"object","properties":{"type":{"description":"Kind of label printed on the carton. Values include order- and carton-level pack lists, retailer packing slips, carton/pallet labels, GS1 labels, and customized or special-instruction labels.","$ref":"#/components/schemas/ShipMonk_OMS_RequiredLabels_Enum_PackingLabelType"},"identifier":{"description":"Identifier printed on the label (e.g. SSCC); null if the label type has no identifier.","type":["string","null"]}},"required":["type","identifier"],"title":"Package Carton Label Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiPackedProductOutput":{"type":"object","properties":{"sku":{"description":"Stock-keeping unit (SKU) of the product packed in this package.","type":"string"},"quantity":{"description":"Number of units of this SKU packed in this package.","type":"integer"},"lots":{"description":"Lot/batch identifiers and quantities for the packed units, when lot tracking applies.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderItemProductLotOutput"}}},"required":["sku","quantity","lots"],"title":"Packed Product Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiRoutingDataOutput":{"type":"object","properties":{"routing_key":{"description":"Identifier of the routing instructions assigned to this shipment (used to match retailer routing guides).","type":"string"}},"required":["routing_key"],"title":"Routing Data Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiSerialNumberItemOutput":{"type":"object","properties":{"sku":{"description":"Stock Keeping Unit (SKU) identifying the product.","type":"string"},"serial_number":{"description":"Serial number recorded for the fulfilled unit.","type":"string"}},"required":["sku","serial_number"],"title":"Serial Number Item Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiSerialNumberOutput":{"type":"object","properties":{"line_key":{"description":"Key of the order line item these serial numbers belong to; null when serial numbers cannot be matched to a specific line.","type":["string","null"]},"serial_numbers":{"description":"Serial numbers recorded for units fulfilled on this order line.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiSerialNumberItemOutput"}}},"required":["line_key","serial_numbers"],"title":"Serial Number Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiShipmentDataOutput":{"type":"object","properties":{"carrier":{"description":"Name of the carrier handling the shipment (e.g. UPS, DHL, FedEx).","type":"string"},"service":{"description":"Carrier service level used (e.g. Ground, Express); null if the carrier does not report a service level.","type":["string","null"]},"carrier_tracking_url":{"description":"Public URL provided by the carrier to track the shipment; null if not available.","type":["string","null"]},"carrier_alpha_code":{"description":"Carrier's Standard Carrier Alpha Code (SCAC), a 2-4 letter identifier; null if not assigned.","type":["string","null"]},"carrier_trans_method_code":{"description":"Carrier transportation method code (e.g. air, ground, ocean); null if not provided by the carrier.","type":["string","null"]},"bill_of_lading_number":{"description":"Bill of lading (BOL) number, the transport document identifier issued by the carrier; null if not yet assigned.","type":["string","null"]},"master_bill_of_lading_number":{"description":"Master bill of lading number grouping multiple BOLs under a consolidated shipment; null if not consolidated.","type":["string","null"]},"load_number":{"description":"Carrier-assigned load number identifying the freight load this shipment belongs to; null if not provided.","type":["string","null"]},"authorization_number":{"description":"Carrier authorization number (e.g. PRO or pickup authorization) issued for the shipment; null if not provided.","type":["string","null"]},"estimated_shipping_cost":{"description":"Estimated shipping cost in the order's currency; null if not yet calculated.","type":["number","null"],"format":"double"},"routing":{"description":"Routing information assigned to the shipment (e.g. for retailer-routed freight); null when routing is not applicable.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiRoutingDataOutput"},{"type":"null"}]}},"required":["carrier","service","carrier_tracking_url","carrier_alpha_code","carrier_trans_method_code","bill_of_lading_number","master_bill_of_lading_number","load_number","authorization_number","estimated_shipping_cost","routing"],"title":"Shipment Data Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiShippingLabelOutput":{"type":"object","properties":{"url":{"description":"URL from which the customer-provided shipping label can be downloaded.","type":"string"}},"required":["url"],"title":"Shipping Label Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiShippingOrderDetailAddressOutput":{"type":"object","properties":{"name":{"description":"Full name of the recipient or contact at this address.","type":["string","null"]},"company":{"description":"Company name at this address, if any.","type":["string","null"]},"street1":{"description":"Primary street address line (e.g. number and street).","type":["string","null"]},"street2":{"description":"Secondary street address line (e.g. apartment, suite, or unit).","type":["string","null"]},"state":{"description":"State, province, or region of the address.","type":["string","null"]},"city":{"description":"City or locality of the address.","type":["string","null"]},"zip":{"description":"Postal or ZIP code of the address.","type":["string","null"]},"country_code":{"description":"ISO 3166-1 alpha-2 country code (e.g. US, DE).","type":["string","null"]},"phone":{"description":"Contact phone number for the address.","type":["string","null"]},"email":{"description":"Contact email for the address.","type":["string","null"]},"residential":{"description":"true if the address is residential, false if commercial, null if unknown.","type":["boolean","null"]}},"required":["name","company","street1","street2","state","city","zip","country_code","phone","email","residential"],"title":"Shipping Order Detail Address Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiSpecialInstructionDateOutput":{"type":"object","properties":{"earliest":{"description":"Earliest acceptable date for the event (ISO-8601 date); null if no lower bound.","type":["string","null"],"format":"date-time"},"requested":{"description":"Preferred target date for the event (ISO-8601 date); null if not specified.","type":["string","null"],"format":"date-time"},"latest":{"description":"Latest acceptable date for the event (ISO-8601 date); null if no upper bound.","type":["string","null"],"format":"date-time"}},"required":["earliest","requested","latest"],"title":"Special Instruction Date Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiSpecialInstructionNameUrlOutput":{"type":"object","properties":{"name":{"description":"Human-readable name or description of the document; null if unnamed.","type":["string","null"]},"url":{"description":"URL from which the document file can be downloaded.","type":"string"}},"required":["name","url"],"title":"Special Instruction Name Url Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiSpecialRequirementsOutput":{"type":"object","properties":{"special_instruction":{"description":"Free-text special handling instructions for the order, or null if none.","type":["string","null"]},"carton_labels":{"description":"Carton labels (name and download URL) that must be applied to the order's cartons.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiSpecialInstructionNameUrlOutput"}},"additional_documents":{"description":"Additional documents (name and download URL) that must accompany the order.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiSpecialInstructionNameUrlOutput"}},"shipping_label":{"description":"Customer-provided shipping label to be used for the order; null if not supplied.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiShippingLabelOutput"},{"type":"null"}]},"shipping_date":{"description":"Requested shipping date with earliest, requested, and latest dates (ISO-8601); null if none requested.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiSpecialInstructionDateOutput"},{"type":"null"}]},"delivery_date":{"description":"Requested delivery date with earliest, requested, and latest dates (ISO-8601); null if none requested.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiSpecialInstructionDateOutput"},{"type":"null"}]},"cancel_date":{"description":"Date (ISO-8601) after which the order should be cancelled if not yet shipped; null if no cutoff.","type":["string","null"],"format":"date-time"},"pack_list_required":{"description":"True if a packing list document must be included with the shipment.","type":"boolean"}},"required":["special_instruction","carton_labels","additional_documents","shipping_label","shipping_date","delivery_date","cancel_date","pack_list_required"],"title":"Special Requirements Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiStoreNameOutput":{"type":"object","properties":{"id":{"description":"Internal numeric identifier of the store.","type":"integer"},"name":{"description":"Display name of the store.","type":"string"}},"required":["id","name"],"title":"Store Name Output"},"Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiWarehouseDetailOutput":{"type":"object","properties":{"identifier":{"description":"Short human-readable code identifying the warehouse.","type":"string"},"id":{"description":"Internal numeric identifier of the warehouse.","type":"integer"},"name":{"description":"Display name of the warehouse.","type":"string"},"warehouse_wms_type":{"description":"Warehouse management system (WMS) backing the warehouse. One of: shipmonk (ShipMonk-operated), merchant_facility (merchant's own facility).","$ref":"#/components/schemas/ShipMonk_WmsConnector_Order_ValueObject_WmsType"}},"required":["identifier","id","name","warehouse_wms_type"],"title":"Warehouse Detail Output"},"Fulfillment_IntegrationsBundle_ApiResource_ReturnInput":{"type":"object","properties":{"warehouse":{"description":"Code of the warehouse that will process this return.","type":"string","minLength":1,"example":"PA1"},"rma":{"description":"Return Merchandise Authorization (RMA) number; must be unique per return and is used as the upsert key.","type":"string","minLength":1},"order_key":{"description":"Order key of the original outbound order this return relates to. Optional; supply to link the return to a known order.","type":["string","null"],"minLength":1,"example":"327b5abd-017a-4504-a50d-54f1cea80269"},"store_id":{"description":"Identifier of the store this return belongs to.","type":"integer","example":123456},"return_reason":{"description":"Reason code for the return, used for reporting: exchange, changed_mind, undeliverable, unknown, or incorrect_product.","$ref":"#/components/schemas/ShipMonk_Warehouse_Returns_Enum_ReturnReason"},"note":{"description":"Optional free-text note attached to the return for internal reference.","type":["string","null"]},"tracking_number":{"description":"Carrier tracking number of the parcel returning to the warehouse; optional, supply when known to enable inbound matching.","type":["string","null"],"minLength":1},"items":{"type":"array","items":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_ReturnItemInput"}},"custom_data":{"type":"array","items":{"$ref":"#/components/schemas/Fulfillment_AccountApiBundle_Input_Return_ReturnIntegrationDataRecordInput"}},"references_to_related_order":{"description":"Optional lookup criteria used to associate this return with an existing order when order_key is unknown.","$ref":"#/components/schemas/Fulfillment_AccountApiBundle_Input_Return_ReferencesToRelatedOrderInput"}},"required":["warehouse","rma","store_id","return_reason","items"],"title":"Return Input"},"Fulfillment_IntegrationsBundle_ApiResource_ReturnItemInput":{"type":"object","properties":{"sku":{"description":"Stock Keeping Unit (SKU) of the returned product; must match an existing product.","type":"string"},"expected_quantity":{"description":"Quantity of this SKU the customer is expected to return; must be a positive integer.","type":"integer","exclusiveMinimum":0},"desired_action":{"description":"Requested handling for the item once received: received_back_into_inventory (restock as sellable) or damaged_not_resellable (write off).","$ref":"#/components/schemas/ShipMonk_Warehouse_Returns_Enum_ReturnItemStatus"}},"required":["sku","expected_quantity","desired_action"],"title":"Return Item Input"},"Fulfillment_IntegrationsBundle_ApiResource_ReturnOutput":{"type":"object","properties":{"id":{"description":"Unique numeric identifier of the return.","type":"integer"},"warehouse":{"description":"Code of the warehouse handling this return.","type":"string"},"order_key":{"description":"External order key of the original order this return relates to; null when no linked order exists.","type":["string","null"]},"store_id":{"description":"Identifier of the store the return belongs to; null if the return is not linked to a store.","type":["integer","null"]},"rma":{"description":"Return Merchandise Authorization (RMA) number identifying this return.","type":"string"},"tracking_number":{"description":"Carrier tracking number of the return shipment; null if not yet known.","type":["string","null"]},"status":{"description":"Current processing status of the return: status_created, in_progress, en_route, returned, arrived, not_arrived, or grading_completed.","$ref":"#/components/schemas/ShipMonk_Warehouse_Returns_Enum_ReturnStatus"},"return_reason":{"description":"Reason the return was initiated: exchange, changed_mind, undeliverable, unknown, or incorrect_product.","$ref":"#/components/schemas/ShipMonk_Warehouse_Returns_Enum_ReturnReason"},"note":{"description":"Optional free-text note attached to the return; null when no note was provided.","type":["string","null"]},"created_at":{"description":"ISO 8601 timestamp when the return record was created.","type":"string","format":"date-time"},"updated_at":{"description":"ISO 8601 timestamp when the return record was last updated.","type":"string","format":"date-time"},"received_at":{"description":"ISO 8601 timestamp when the return was physically received at the warehouse; null until received.","type":["string","null"],"format":"date-time"},"items":{"description":"Line items included in the return, each with expected and received quantities.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Crate_PublicApiReturnItemOutput"}},"custom_data":{"description":"List of custom name/value pairs attached to the return by the source integration.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_CommonBundle_ApiResource_IntegrationDataOutput"}},"source":{"description":"System that originated this return record: shipmonk, loop, returnly, deposco, happy_returns_loop, or happy_returns.","$ref":"#/components/schemas/ShipMonk_Warehouse_Returns_Enum_ReturnEntitySource"}},"required":["id","warehouse","order_key","store_id","rma","tracking_number","status","return_reason","note","created_at","updated_at","received_at","items","custom_data","source"],"title":"Return Output"},"Fulfillment_IntegrationsBundle_Crate_NotifyShipmentPackingConfigurationPackingGroupOutput":{"type":"object","properties":{"key":{"type":"string"},"name":{"type":["string","null"]}},"required":["key","name"],"title":"Notify Shipment Packing Configuration Packing Group Output"},"Fulfillment_IntegrationsBundle_Crate_OrderSyncOutput":{"type":"object","properties":{"message":{"description":"Human-readable message indicating whether the order was created or updated.","type":"string"}},"required":["message"],"title":"Order Sync Output"},"Fulfillment_IntegrationsBundle_Crate_PublicApiReceivingItemDetailsOutput":{"type":"object","properties":{"lot":{"description":"Lot/batch tracking data for the units in this receipt entry, or null if no lot is tracked.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Crate_ReturnOrReceivingItemLotPublicApiOutput"},{"type":"null"}]},"expected_quantity":{"description":"Number of units expected in this lot/batch entry.","type":"integer"},"received_quantity":{"description":"Number of units actually received in this lot/batch entry.","type":"integer"},"received_at":{"description":"Timestamp when this batch was received at the warehouse, in ISO 8601 format. Null if not yet received.","type":["string","null"],"format":"date-time"},"line_key":{"type":["string","null"]}},"required":["lot","expected_quantity","received_quantity","received_at","line_key"],"title":"Receiving Item Details Output"},"Fulfillment_IntegrationsBundle_Crate_PublicApiReturnItemOutput":{"type":"object","properties":{"product":{"description":"The product identified by this receiving item.","$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Crate_ReturnOrReceivingItemProductPublicApiOutput"},"expected_quantity":{"description":"Total number of units of this product expected to be received.","type":"integer"},"received_quantity":{"description":"Total number of units of this product received so far across all batches.","type":"integer"},"receiving_details":{"description":"Per-unit receiving records for this return item, capturing lot, quantities, timestamps, and final disposition.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Crate_ReturnItemDetailsPublicApiOutput"}},"desired_action":{"description":"Requested handling for the returned item: received_back_into_inventory or damaged_not_resellable.","$ref":"#/components/schemas/ShipMonk_Warehouse_Returns_Enum_ReturnItemStatus"}},"required":["product","expected_quantity","received_quantity","receiving_details","desired_action"],"title":"Return Item Output"},"Fulfillment_IntegrationsBundle_Crate_ReceivingCreateOrUpdateOutput":{"type":"object","properties":{"message":{"description":"Human-readable message indicating whether the receiving was created or updated.","type":"string"}},"required":["message"],"title":"Receiving Create Or Update Output"},"Fulfillment_IntegrationsBundle_Crate_ReturnItemDetailsPublicApiOutput":{"type":"object","properties":{"lot":{"description":"Lot/batch tracking data for the units in this receipt entry, or null if no lot is tracked.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Crate_ReturnOrReceivingItemLotPublicApiOutput"},{"type":"null"}]},"expected_quantity":{"description":"Number of units expected in this lot/batch entry.","type":"integer"},"received_quantity":{"description":"Number of units actually received in this lot/batch entry.","type":"integer"},"received_at":{"description":"Timestamp when this batch was received at the warehouse, in ISO 8601 format. Null if not yet received.","type":["string","null"],"format":"date-time"},"type_scoped_id":{"description":"Identifier unique within records of the same type; combine with the type field for a globally unique reference.","type":"integer"},"type":{"description":"Type of the receiving detail record: receive (standard warehouse receipt) or optoro_inventory (record sourced from Optoro inventory).","$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Crate_ReturnItemDetailsType"},"final_disposition":{"description":"Final disposition decided for the unit after inspection (e.g. restocked, damaged); null while disposition is pending.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_Warehouse_Returns_Enum_ReturnItemFinalDisposition"},{"type":"null"}]}},"required":["lot","expected_quantity","received_quantity","received_at","type_scoped_id","type","final_disposition"],"title":"Return Item Details Output"},"Fulfillment_IntegrationsBundle_Crate_ReturnItemDetailsType":{"type":["string"],"enum":["receive","optoro_inventory"],"title":"Return Item Details Type"},"Fulfillment_IntegrationsBundle_Crate_ReturnOrReceivingItemLotPublicApiOutput":{"type":"object","properties":{"lot_number":{"description":"Lot/batch number assigned by the supplier, or null if not provided.","type":["string","null"]},"expiration_date":{"description":"Lot expiration date in ISO 8601 format (YYYY-MM-DD), or null if not applicable.","type":["string","null"],"format":"date-time"}},"required":["lot_number","expiration_date"],"title":"Return Or Receiving Item Lot Output"},"Fulfillment_IntegrationsBundle_Crate_ReturnOrReceivingItemProductPublicApiOutput":{"type":"object","properties":{"id":{"description":"Server-assigned numeric identifier of the product.","type":"integer"},"sku":{"description":"Stock Keeping Unit (SKU), the client's unique product code.","type":"string"},"name":{"description":"Human-readable name of the product.","type":"string"}},"required":["id","sku","name"],"title":"Return Or Receiving Item Product Output"},"Fulfillment_IntegrationsBundle_Crate_ReturnsListPublicApiOutput":{"type":"object","properties":{"returns_list":{"description":"Returns matching the query criteria.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_ReturnOutput"}}},"required":["returns_list"],"title":"Returns List Output"},"Fulfillment_IntegrationsBundle_Enum_CartonLabelType":{"type":["string"],"enum":["gs1","shipmonk_gs1","customized_carton_labels","custom"],"title":"Carton Label Type"},"Fulfillment_IntegrationsBundle_Enum_OrderLevelPackingSlipType":{"type":["string"],"enum":["retailer"],"title":"Order Level Packing Slip Type"},"Fulfillment_IntegrationsBundle_Enum_ReceivingCompletionMode":{"type":["string"],"enum":["fully_received","short_received","excess_received","partially_received"],"title":"Receiving Completion Mode"},"Fulfillment_IntegrationsBundle_Enum_SandboxPackType":{"type":["string"],"enum":["singlepack","multipack"],"title":"Sandbox Pack Type"},"Fulfillment_IntegrationsBundle_Enum_ShipmentNotificationExtraDataType":{"type":["string"],"enum":["carrierShippingMethod"],"title":"Shipment Notification Extra Data Type"},"Fulfillment_IntegrationsBundle_Input_CompleteOrderInput":{"type":"object","properties":{"order_key":{"description":"Unique identifier of the order in the external (caller's) system, as originally supplied when the order was created.","type":"string","example":"327b5abd-017a-4504-a50d-54f1cea80269"},"store_id":{"description":"Identifier of the store this return belongs to.","type":"integer","example":123456},"pack_type":{"description":"Optional packaging type for the simulated fulfillment: 'singlepack' (all items in one box) or 'multipack' (items split across multiple boxes).","$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Enum_SandboxPackType","default":"singlepack"}},"required":["order_key","store_id"],"title":"Complete Order Input"},"Fulfillment_IntegrationsBundle_Input_CompleteSandboxReturnInput":{"type":"object","properties":{"rma":{"description":"Return Merchandise Authorization (RMA) number; must be unique per return and is used as the upsert key.","type":"string","minLength":1,"maxLength":255},"completion_mode":{"description":"How the sandbox should simulate return completion: 'fully_received' (all expected units), 'short_received' (fewer than expected), 'excess_received' (more than expected), or 'partially_received' (partial completion).","$ref":"#/components/schemas/ShipMonk_Warehouse_Returns_Sandbox_Enum_SandboxReturnsCompletionMode"},"final_disposition":{"description":"Simulated final disposition of returned items: 'reworked', 'returned_to_inventory', 'return_to_merchant', 'dispose', or 'donate'.","$ref":"#/components/schemas/ShipMonk_Warehouse_Returns_Sandbox_Enum_SandboxReturnDisposition"}},"required":["rma","completion_mode","final_disposition"],"title":"Complete Sandbox Return Input"},"Fulfillment_IntegrationsBundle_Input_ReceivingCompleteInput":{"type":"object","properties":{"receiving_key":{"description":"Caller-supplied unique identifier of the receiving (purchase order). Either receiving_key or asn must be provided to identify the target receiving.","type":["string","null"],"example":"key-123"},"asn":{"description":"Optional filter to retrieve a receiving by its Advance Shipping Notice (ASN) number, a supplier-provided identifier for the incoming shipment.","type":["string","null"],"example":"ASN-12345"},"completion_mode":{"description":"How the sandbox should simulate completion: 'fully_received' (all expected units), 'short_received' (fewer than expected), 'excess_received' (more than expected), or 'partially_received' (partial completion that leaves the receiving open).","$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Enum_ReceivingCompletionMode"}},"required":["completion_mode"],"title":"Receiving Complete Input"},"Fulfillment_IntegrationsBundle_Input_SubmitOrderIntoQueueForFulfillmentAtDateInput":{"type":"object","properties":{"order_key":{"description":"Unique identifier of the order in the external (caller's) system, as originally supplied when the order was created.","type":"string","example":"327b5abd-017a-4504-a50d-54f1cea80269"},"store_id":{"description":"Identifier of the store this return belongs to.","type":"integer","example":123456},"submit_at":{"description":"ISO 8601 timestamp at which the order should be released into the fulfillment queue; submitting in the past releases it immediately.","type":"string","format":"date-time","example":"2025-07-24 14:53:00"}},"required":["order_key","store_id","submit_at"],"title":"Submit Order Into Queue For Fulfillment At Date Input"},"Fulfillment_IntegrationsBundle_Type_OrderSyncOrderStatus":{"type":["string"],"enum":["unfulfilled","fulfilled","cancelled","onHold"],"x-enumDescriptions":{"unfulfilled":"Order will be fulfilled by ShipMonk","fulfilled":"Order has been already fulfilled, ShipMonk won't fulfill this order","cancelled":"Order won't be fulfilled by ShipMonk","onHold":"Order is temporarily on hold and can be restored or cancelled any time"},"title":"Order Sync Order Status"},"Fulfillment_InventoryBundle_Enum_PackagingType":{"type":["string"],"enum":["poly_mailer","bubble_mailer","box","slap_a_label","custom"],"title":"Packaging Type"},"Fulfillment_OrderBundle_Enum_FulfillmentStrategy":{"type":["string"],"enum":["standard","drop-ship","cross-dock"],"title":"Fulfillment Strategy"},"Fulfillment_OrderBundle_Enum_OrderItemSource":{"type":["string"],"enum":["imported","manual","inserted","packaging","claim_reship"],"title":"Order Item Source"},"Fulfillment_OrderBundle_Enum_OrderListStatus":{"type":["string"],"enum":["backorder","unable_to_submit","queued_to_submit","subscription","package_forwarding","awaiting_label_request_from_merchant_facility","on_hold","submitted","pick_in_progress","pack_in_progress","packed","awaiting_pick_up","awaiting_carrier_processing","en_route","delivered","undeliverable","shipped_untrackable","fulfilled_by_3rd","cancellation_requested","cancelled","updating"],"title":"Order List Status"},"Fulfillment_OrderBundle_Enum_OrderReferenceType":{"type":["string"],"enum":["order_number","original_imported_order_number","customer_order_number","po_number","reference_number","b2b_routing_reference","release_number","job_number","depositor_order_number"],"title":"Order Reference Type"},"Fulfillment_OrderBundle_Enum_OrderSize":{"type":["string"],"enum":["unknown","regular","oversized_item","large","extra_large"],"title":"Order Size"},"Fulfillment_PublicApiBundle_ApiResource_Address_AddressDetailOutput":{"type":"object","properties":{"name":{"type":["string","null"]},"company":{"type":["string","null"]},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"street3":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"postal_code":{"type":["string","null"]},"phone":{"type":["string","null"]},"residential":{"type":"boolean"},"verified":{"type":"boolean"},"country":{"type":["string","null"]}},"required":["name","company","street1","street2","street3","city","state","postal_code","phone","residential","verified","country"],"title":"Address Detail Output"},"Fulfillment_PublicApiBundle_ApiResource_Carrier_PublicApiCarrierDetailOutput":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"title":"Carrier Detail Output"},"Fulfillment_PublicApiBundle_ApiResource_Inventory_InventoryDetailOutput":{"type":"object","properties":{"quantity_total_final":{"description":"Total finalized quantity across all locations: units that have completed receiving and are fully accounted for in inventory.","type":"integer"},"quantity_total_available":{"description":"Total quantity available to allocate to new orders across all locations.","type":"integer"},"quantity_total_on_hand":{"description":"Total quantity physically present in warehouses (including allocated, quarantined and unavailable units).","type":"integer"},"quantity_total_quarantined":{"description":"Total quantity held in quarantine (e.g., pending inspection) and not available for fulfillment.","type":"integer"},"quantity_total_unavailable":{"description":"Total quantity unavailable for fulfillment for reasons other than quarantine (e.g., damaged or reserved).","type":"integer"},"locations":{"description":"Per-warehouse breakdown of the inventory totals above.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_ApiResource_Location_LocationListOutput"}}},"required":["quantity_total_final","quantity_total_available","quantity_total_on_hand","quantity_total_quarantined","quantity_total_unavailable","locations"],"title":"Inventory Detail Output"},"Fulfillment_PublicApiBundle_ApiResource_Location_LocationListOutput":{"type":"object","properties":{"quantity_final":{"description":"Finalized quantity at this warehouse: units fully received and accounted for in inventory.","type":"integer"},"quantity_available":{"description":"Quantity available to allocate to new orders at this warehouse.","type":"integer"},"quantity_on_hand":{"description":"Quantity physically present at this warehouse (including allocated, quarantined and unavailable units).","type":"integer"},"quarantined_quantity":{"description":"Quantity held in quarantine at this warehouse and not available for fulfillment.","type":"integer"},"quantity_unavailable":{"description":"Quantity at this warehouse unavailable for fulfillment for reasons other than quarantine.","type":"integer"},"quantity_by_lot":{"description":"On-hand quantity at this warehouse broken down by lot/expiration.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_ApiResource_LotControl_LotControlWithQuantityOutput"}},"warehouse":{"description":"Warehouse where these inventory quantities are held.","$ref":"#/components/schemas/Fulfillment_PublicApiBundle_ApiResource_Warehouse_WarehouseDetailOutput"}},"required":["quantity_final","quantity_available","quantity_on_hand","quarantined_quantity","quantity_unavailable","quantity_by_lot","warehouse"],"title":"Location List Output"},"Fulfillment_PublicApiBundle_ApiResource_LotControl_LotControlOutput":{"type":"object","properties":{"lot_number":{"description":"Lot number assigned to the product batch, or null if the lot is identified only by expiration date.","type":["string","null"]},"expiration_date":{"description":"Lot expiration date in ISO 8601 format (YYYY-MM-DD), or null if not applicable.","type":["string","null"],"format":"date-time"}},"required":["lot_number","expiration_date"],"title":"Lot Control Output"},"Fulfillment_PublicApiBundle_ApiResource_LotControl_LotControlWithQuantityOutput":{"type":"object","properties":{"lot":{"description":"Lot identification (lot number and/or expiration date) for this inventory entry. Null when the inventory is not tracked by lot.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_ApiResource_LotControl_LotControlOutput"},{"type":"null"}]},"quantity_on_hand":{"description":"Quantity physically on hand for this lot at the location.","type":"integer"}},"required":["lot","quantity_on_hand"],"title":"Lot Control With Quantity Output"},"Fulfillment_PublicApiBundle_ApiResource_Order_PublicApiOrderTaxIdOutput":{"type":"object","properties":{"tax_id_type":{"description":"Type of tax identifier. One of: VAT, IOSS, TIN, EIN, EORI, ARN, RFC, CPF, CNPJ, PCCC.","$ref":"#/components/schemas/Fulfillment_UserBundle_Enum_TaxIdType"},"value":{"description":"Tax identification number, formatted according to its type and issuing country.","type":"string"},"issuing_country":{"description":"Country that issued the tax identification number.","$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiCountryDetailOutput"}},"required":["tax_id_type","value","issuing_country"],"title":"Order Tax Id Output"},"Fulfillment_PublicApiBundle_ApiResource_Product_BundleOutput":{"type":"object","properties":{"bundle_sku":{"description":"SKU of the bundle product that contains this item as a component.","type":"string"},"products":{"description":"Component products that make up this bundle.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_ApiResource_Product_BundleProductOutput"}}},"required":["bundle_sku","products"],"title":"Bundle Output"},"Fulfillment_PublicApiBundle_ApiResource_Product_BundleProductOutput":{"type":"object","properties":{"sku":{"description":"SKU of the product included in the bundle.","type":"string"},"quantity":{"description":"Number of units of this product included per bundle.","type":"integer"}},"required":["sku","quantity"],"title":"Bundle Product Output"},"Fulfillment_PublicApiBundle_ApiResource_Product_ProductHandlingUnitOutput":{"type":"object","properties":{"type":{"description":"Type of the handling unit. Allowed values: inner_carton, master_carton, pallet.","$ref":"#/components/schemas/ShipMonk_OMS_Product_Enum_ProductHandlingUnitType"},"weight":{"description":"Total weight of one handling unit.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_Measurement_Output_WeightOutput"},{"type":"null"}]},"dimensions":{"description":"Physical dimensions of one handling unit.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_Measurement_Output_DimensionsOutput"},{"type":"null"}]},"count":{"description":"Number of individual product units per handling unit.","type":"integer"}},"required":["type","weight","dimensions","count"],"title":"Product Handling Unit Output"},"Fulfillment_PublicApiBundle_ApiResource_Product_ProductListOutput":{"type":"object","properties":{"id":{"description":"Server-assigned numeric identifier of the product.","type":"integer"},"sku":{"description":"Stock Keeping Unit (SKU), the client's unique product code.","type":"string"},"name":{"description":"Human-readable name of the product.","type":"string"},"created_at":{"description":"ISO 8601 timestamp indicating when the product was created.","type":"string","format":"date-time"},"updated_at":{"description":"ISO 8601 timestamp indicating when the product was last updated.","type":"string","format":"date-time"},"inventory_on_hand_last_updated_at":{"description":"ISO 8601 timestamp of the most recent on-hand inventory change for this product, or null if no inventory has ever been recorded.","type":["string","null"],"format":"date-time"},"is_active":{"description":"Whether the product is currently active and available for fulfillment.","type":["boolean","null"]},"product_type":{"description":"Deprecated. Always returns \"unit\".","deprecated":true,"type":"string"},"replacement_cost":{"description":"Declared replacement cost of a single unit of the product, in the currency given by replacement_cost_currency.","type":["number","null"],"format":"double"},"replacement_cost_currency":{"description":"ISO 4217 currency code for replacement_cost.","type":["string","null"]},"inventory":{"description":"Aggregated inventory levels for this product across all warehouses.","$ref":"#/components/schemas/Fulfillment_PublicApiBundle_ApiResource_Inventory_InventoryDetailOutput"},"hs_code":{"description":"Deprecated: use $hsCodes Deprecated. Use hs_codes instead.","deprecated":true,"type":["string","null"]},"hs_codes":{"description":"Harmonized System (HS) codes assigned to this product, per customs region.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_AdminApiBundle_ApiResource_ProductHsCodeDetailOutput"}},"barcodes":{"description":"Barcodes associated with this product (e.g., UPC, EAN).","type":"array","items":{"type":"string"}},"country_code":{"description":"ISO 3166-1 alpha-2 country of origin code for the product.","type":["string","null"]},"stock_out_days":{"description":"Projected number of days until the product runs out of stock based on recent sales velocity.","type":"integer"},"custom_data":{"description":"Custom key-value pairs attached to this product, as supplied when creating or updating it.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_CommonBundle_ApiResource_IntegrationDataOutput"}},"weight":{"description":"Weight of a single unit of the product. Null when no weight has been recorded.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_Measurement_Output_WeightOutput"},{"type":"null"}]},"dimensions":{"description":"Physical dimensions of a single unit of the product. Null when no dimensions have been recorded.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_Measurement_Output_DimensionsOutput"},{"type":"null"}]},"product_bundles":{"description":"Bundles (multi-SKU kits) that include this product as a component.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_ApiResource_Product_BundleOutput"}},"product_handling_units":{"description":"Handling unit configurations defined for this product (inner carton, master carton, pallet).","type":["array","null"],"items":{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_ApiResource_Product_ProductHandlingUnitOutput"}}},"required":["id","sku","name","created_at","updated_at","inventory_on_hand_last_updated_at","is_active","product_type","replacement_cost","replacement_cost_currency","inventory","hs_code","hs_codes","barcodes","country_code","stock_out_days","custom_data","weight","dimensions","product_bundles","product_handling_units"],"title":"Product List Output"},"Fulfillment_PublicApiBundle_ApiResource_Product_ProductSearchOutput":{"type":"object","properties":{"total":{"description":"Total number of results matching the search criteria.","type":"integer"},"cursor":{"description":"Cursor to pass to the paginate endpoint to retrieve results. Null when there are no results.","type":["string","null"]}},"required":["total","cursor"],"title":"Product Search Output"},"Fulfillment_PublicApiBundle_ApiResource_Product_ProductSearchResultsOutput":{"type":"object","properties":{"data":{"description":"Products in the current page of results.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_ApiResource_Product_ProductListOutput"}},"total":{"description":"Total number of results found for the original search.","type":"integer"},"next_cursor":{"description":"Cursor to fetch the next page of results; null when there are no more results.","type":["string","null"]}},"required":["data","total","next_cursor"],"title":"Product Search Results Output"},"Fulfillment_PublicApiBundle_ApiResource_ShippingMethod_PublicApiShippingMethodDetailOutput":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"carrier":{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_ApiResource_Carrier_PublicApiCarrierDetailOutput"}},"required":["id","name","carrier"],"title":"Shipping Method Detail Output"},"Fulfillment_PublicApiBundle_ApiResource_Warehouse_WarehouseDetailOutput":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"identifier":{"type":"string"}},"required":["id","name","identifier"],"title":"Warehouse Detail Output"},"Fulfillment_PublicApiBundle_ApiResource_Warehouse_WarehouseListOutput":{"type":"object","properties":{"id":{"description":"Unique numeric identifier of the warehouse.","type":"integer"},"identifier":{"description":"Short warehouse code (e.g., CA1) used as a stable, human-readable reference.","type":"string"},"name":{"description":"Display name of the warehouse.","type":"string"},"timezone":{"description":"IANA time zone of the warehouse location (e.g., America/Los_Angeles).","type":"string"},"warehouse_wms_type":{"description":"Warehouse management system backing this warehouse.","type":"string"},"enabled":{"description":"Whether the warehouse is currently active and accepting shipments.","type":"boolean"},"address":{"description":"Physical address of the warehouse.","$ref":"#/components/schemas/Fulfillment_PublicApiBundle_ApiResource_Address_AddressDetailOutput"}},"required":["id","identifier","name","timezone","warehouse_wms_type","enabled","address"],"title":"Warehouse List Output"},"Fulfillment_PublicApiBundle_Enum_ProductInventorySearchSortBy":{"type":["string"],"enum":["id","created_at","inventory_on_hand_last_updated_at"],"title":"Product Inventory Search Sort By"},"Fulfillment_PublicApiBundle_Enum_ProductStatusFilterEnum":{"type":["string"],"enum":["blacklisted","active","disabled"],"title":"Product Status Filter Enum"},"Fulfillment_PublicApiBundle_Enum_PublicApiOrdering":{"type":["string"],"enum":["DESC","ASC"],"title":"Ordering"},"Fulfillment_PublicApiBundle_Enum_Warehouse_WarehouseListSortEnum":{"type":["string"],"enum":["name","id"],"title":"Warehouse List Sort Enum"},"Fulfillment_PublicApiBundle_Input_DateTimeRangeInclusiveInput":{"type":"object","properties":{"is_after_or_equal":{"description":"Lower bound (inclusive) of the date-time range, in ISO 8601 format.","type":"string","format":"date-time","default":null,"example":"2025-07-24 14:53:00"},"is_before_or_equal":{"description":"Upper bound (inclusive) of the date-time range, in ISO 8601 format.","type":"string","format":"date-time","default":null,"example":"2025-07-24 14:53:00"}},"required":[],"title":"Date Time Range Inclusive Input"},"Fulfillment_PublicApiBundle_Input_ProductSearchFiltersInput":{"type":"object","properties":{"search":{"description":"String to match against SKU, name or barcode. SKU and name match by substring (\"air\" matches \"chair\"); barcodes must match exactly.","type":["string","null"],"minLength":1,"maxLength":255,"default":null},"status":{"description":"Filter results by product status. Omit to return products in any status.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_Enum_ProductStatusFilterEnum"},{"type":"null"}],"default":null},"created_at":{"description":"Filter products by creation date-time range (inclusive). Applies to products created via API or manually.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_Input_DateTimeRangeInclusiveInput"},{"type":"null"}],"default":null},"inventory_on_hand_last_updated_at":{"description":"Filter products by the date-time their on-hand inventory was last updated. Updates occur on receiving, inventory adjustments, packing, etc., and may lag changes by a few seconds.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_Input_DateTimeRangeInclusiveInput"},{"type":"null"}],"default":null}},"required":[],"title":"Product Search Filters Input"},"Fulfillment_PublicApiBundle_Input_ProductSearchSortInput":{"type":"object","properties":{"sort_by":{"description":"Field to sort the results by. Allowed values: id, created_at, inventory_on_hand_last_updated_at.","$ref":"#/components/schemas/Fulfillment_PublicApiBundle_Enum_ProductInventorySearchSortBy","default":"id"},"sort_order":{"description":"Sort direction. Allowed values: ASC (ascending), DESC (descending).","$ref":"#/components/schemas/Fulfillment_PublicApiBundle_Enum_PublicApiOrdering","default":"ASC"}},"required":[],"title":"Product Search Sort Input"},"Fulfillment_PublicApiBundle_Input_SearchProductsInput":{"type":"object","properties":{"filters":{"anyOf":[{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_Input_ProductSearchFiltersInput"},{"type":"null"}],"default":null},"sort":{"anyOf":[{"$ref":"#/components/schemas/Fulfillment_PublicApiBundle_Input_ProductSearchSortInput"},{"type":"null"}],"default":null}},"required":[],"title":"Search Products Input"},"Fulfillment_UserBundle_Enum_TaxIdType":{"type":["string"],"enum":["VAT","IOSS","TIN","EIN","EORI","ARN","RFC","CPF","CNPJ","PCCC"],"title":"Tax Id Type"},"ShipMonk_Api_Output_PaginatorOutput":{"type":"object","properties":{"total":{"type":"integer"},"pages":{"type":"integer"},"page":{"type":"integer"}},"required":["total","pages","page"],"title":"Paginator Output"},"ShipMonk_Measurement_Output_DimensionsOutput":{"type":"object","properties":{"length":{"description":"Length in the unit specified by the sibling \"unit\" field.","type":"number","format":"double"},"width":{"description":"Width in the unit specified by the sibling \"unit\" field.","type":"number","format":"double"},"height":{"description":"Height in the unit specified by the sibling \"unit\" field.","type":"number","format":"double"},"unit":{"description":"Unit of measurement applied to length, width and height. Allowed values: m, cm, mm, ft, in.","$ref":"#/components/schemas/ShipMonk_Measurement_ValueObject_LengthUnit"}},"required":["length","width","height","unit"],"title":"Dimensions Output"},"ShipMonk_Measurement_Output_WeightOutput":{"type":"object","properties":{"value":{"description":"Numeric weight value, expressed in the unit given by the unit field.","type":"number","format":"double"},"unit":{"description":"Unit of measure for the weight value. One of: kg, g, lb, oz.","$ref":"#/components/schemas/ShipMonk_Measurement_ValueObject_WeightUnit"}},"required":["value","unit"],"title":"Weight Output"},"ShipMonk_Measurement_ValueObject_LengthUnit":{"type":["string"],"enum":["m","cm","mm","ft","in"],"title":"Length Unit"},"ShipMonk_Measurement_ValueObject_WeightUnit":{"type":["string"],"enum":["kg","g","lb","oz"],"title":"Weight Unit"},"ShipMonk_Money_Output_MoneyOutput":{"type":"object","properties":{"amount":{"description":"Decimal monetary amount in the currency given by the sibling currency field.","type":"number","format":"double"},"currency":{"description":"ISO 4217 currency code (e.g. USD, EUR) for the accompanying amount.","type":"string"}},"required":["amount","currency"],"title":"Money Output"},"ShipMonk_OMS_HsCode_Enum_HsCodeRegion":{"type":["string"],"enum":["us","uk","eu"],"title":"Hs Code Region"},"ShipMonk_OMS_Notification_ApiResource_CustomDataOutput":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"object"}},"required":["name","value"],"title":"Custom Data Output"},"ShipMonk_OMS_Notification_ApiResource_DateTimeOutput":{"type":"object","properties":{"date":{"type":"string"},"timezone":{"type":"string"},"timezone_type":{"type":"integer"}},"required":["date","timezone","timezone_type"],"title":"Date Time Output"},"ShipMonk_OMS_Notification_ApiResource_MainOrderOutput":{"type":"object","properties":{"order_number":{"type":"string"},"parts":{"type":"array","items":{"$ref":"#/components/schemas/ShipMonk_OMS_Notification_ApiResource_OrderPartOutput"}}},"required":["order_number","parts"],"title":"Main Order Output"},"ShipMonk_OMS_Notification_ApiResource_OrderPartOutput":{"type":"object","properties":{"order_number":{"type":"string"}},"required":["order_number"],"title":"Order Part Output"},"ShipMonk_OMS_Notification_ApiResource_OrderPartsOutput":{"type":"object","properties":{"main_order":{"$ref":"#/components/schemas/ShipMonk_OMS_Notification_ApiResource_MainOrderOutput"}},"required":["main_order"],"title":"Order Parts Output"},"ShipMonk_OMS_Notification_ApiResource_PackageOutput":{"type":"object","properties":{"tracking_number":{"type":["string","null"]},"tracking_link":{"type":["string","null"]},"carrier_tracking_url":{"type":["string","null"]},"weight_lb":{"type":["number","null"],"format":"double"},"packed_products":{"type":["array","null"],"items":{"type":"object","properties":{"sku":{"type":"string"},"quantity":{"type":"integer"},"lots":{"type":"array","items":{"type":"object","properties":{"lot_number":{"type":["string","null"]},"expiration_date":{"type":["string","null"]}},"required":["lot_number","expiration_date"]}},"line_key":{"type":["string","null"]}},"required":["sku","quantity","lots","line_key"]}},"box_number":{"type":["integer","null"]},"pallet_number":{"type":["integer","null"]},"carton_labels":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ShipMonk_OMS_Notification_ApiResource_PackingLabelOutput"}},"pallet_weight_lb":{"type":["number","null"],"format":"double"},"packing_group":{"anyOf":[{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Crate_NotifyShipmentPackingConfigurationPackingGroupOutput"},{"type":"null"}]},"packed_items":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ShipMonk_OMS_Notification_ApiResource_PackedOrderItemOutput"}}},"required":["tracking_number","tracking_link","carrier_tracking_url","weight_lb","packed_products","box_number","pallet_number","carton_labels","pallet_weight_lb","packing_group","packed_items"],"title":"Package Output"},"ShipMonk_OMS_Notification_ApiResource_PackedOrderItemOutput":{"type":"object","properties":{"sku":{"type":"string"},"line_key":{"type":["string","null"]},"quantity":{"type":"integer"}},"required":["sku","line_key","quantity"],"title":"Packed Order Item Output"},"ShipMonk_OMS_Notification_ApiResource_PackingLabelOutput":{"type":"object","properties":{"type":{"type":"string"},"identifier":{"type":["string","null"]}},"required":["type","identifier"],"title":"Packing Label Output"},"ShipMonk_OMS_Notification_ApiResource_PalletOutput":{"type":"object","properties":{"number":{"type":"integer"},"weight":{"anyOf":[{"$ref":"#/components/schemas/ShipMonk_Measurement_Output_WeightOutput"},{"type":"null"}]},"dimensions":{"anyOf":[{"$ref":"#/components/schemas/ShipMonk_Measurement_Output_DimensionsOutput"},{"type":"null"}]},"labels":{"type":"array","items":{"$ref":"#/components/schemas/ShipMonk_OMS_Notification_ApiResource_PackingLabelOutput"}}},"required":["number","weight","dimensions","labels"],"title":"Pallet Output"},"ShipMonk_OMS_Notification_ApiResource_RoutingOutput":{"type":"object","properties":{"routing_key":{"type":["string","null"]}},"required":["routing_key"],"title":"Routing Output"},"ShipMonk_OMS_Notification_ApiResource_SerialNumberItemOutput":{"type":"object","properties":{"sku":{"type":"string"},"serial_number":{"type":"string"}},"required":["sku","serial_number"],"title":"Serial Number Item Output"},"ShipMonk_OMS_Notification_ApiResource_SerialNumbersOutput":{"type":"object","properties":{"line_key":{"type":["string","null"]},"serial_numbers":{"type":"array","items":{"$ref":"#/components/schemas/ShipMonk_OMS_Notification_ApiResource_SerialNumberItemOutput"}}},"required":["line_key","serial_numbers"],"title":"Serial Numbers Output"},"ShipMonk_OMS_Notification_ApiResource_ShipFromAddressOutput":{"type":"object","properties":{"name":{"type":["string","null"]},"company":{"type":["string","null"]},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"state":{"type":["string","null"]},"city":{"type":["string","null"]},"zip":{"type":["string","null"]},"country_code":{"type":["string","null"]},"phone":{"type":["string","null"]},"email":{"type":["string","null"]},"residential":{"type":"boolean"}},"required":["name","company","street1","street2","state","city","zip","country_code","phone","email","residential"],"title":"Ship From Address Output"},"ShipMonk_OMS_Notification_ApiResource_ShipToAddressOutput":{"type":"object","properties":{"name":{"type":["string","null"]},"company":{"type":["string","null"]},"street1":{"type":["string","null"]},"street2":{"type":["string","null"]},"state":{"type":["string","null"]},"city":{"type":["string","null"]},"zip":{"type":["string","null"]},"country_code":{"type":["string","null"]},"phone":{"type":["string","null"]},"email":{"type":["string","null"]},"residential":{"type":"boolean"}},"required":["name","company","street1","street2","state","city","zip","country_code","phone","email","residential"],"title":"Ship To Address Output"},"ShipMonk_OMS_Notification_ApiResource_ShipmentNotificationExtraDataOutput":{"type":"object","properties":{"label":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Enum_ShipmentNotificationExtraDataType"},"value":{"type":"string"}},"required":["label","value"],"title":"Shipment Notification Extra Data Output"},"ShipMonk_OMS_Notification_ApiResource_ShipmentNotificationItemWithProductLotOutput":{"type":"object","properties":{"line_key":{"type":["string","null"]},"quantity":{"type":"integer"},"ordered_quantity":{"type":"integer"},"sku":{"type":"string"},"name":{"type":["string","null"]},"source":{"$ref":"#/components/schemas/Fulfillment_OrderBundle_Enum_OrderItemSource"},"products":{"type":"array","items":{"$ref":"#/components/schemas/ShipMonk_OMS_Notification_ApiResource_ShipmentNotificationProductLotOutput"}},"fulfilled_quantity":{"type":"integer"}},"required":["line_key","quantity","ordered_quantity","sku","name","source","products","fulfilled_quantity"],"title":"Shipment Notification Item With Product Lot Output"},"ShipMonk_OMS_Notification_ApiResource_ShipmentNotificationLotOutput":{"type":"object","properties":{"number":{"type":["string","null"]},"expiration_date":{"type":["string","null"],"format":"date"}},"required":["number","expiration_date"],"title":"Shipment Notification Lot Output"},"ShipMonk_OMS_Notification_ApiResource_ShipmentNotificationOutput":{"type":"object","properties":{"order_key":{"type":"string"},"parent_order_key":{"type":["string","null"]},"order_number":{"type":"string"},"warehouse":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ShipMonk_OMS_Notification_ApiResource_ShipmentNotificationItemWithProductLotOutput"}},"store_id":{"type":"string"},"carrier":{"type":"string"},"service":{"type":["string","null"]},"master_tracking_number":{"type":"string"},"tracking_link":{"type":["string","null"]},"estimated_shipping_cost":{"type":["number","null"],"format":"double"},"custom_data":{"type":"array","items":{"$ref":"#/components/schemas/ShipMonk_OMS_Notification_ApiResource_CustomDataOutput"}},"carrier_tracking_url":{"type":["string","null"]},"carrier_alpha_code":{"type":["string","null"]},"carrier_trans_method_code":{"type":["string","null"]},"bill_of_lading_number":{"type":["string","null"]},"master_bill_of_lading_number":{"type":["string","null"]},"load_number":{"type":["string","null"]},"authorization_number":{"type":["string","null"]},"order_parts":{"$ref":"#/components/schemas/ShipMonk_OMS_Notification_ApiResource_OrderPartsOutput"},"serial_numbers":{"type":"array","items":{"$ref":"#/components/schemas/ShipMonk_OMS_Notification_ApiResource_SerialNumbersOutput"}},"order_size":{"$ref":"#/components/schemas/Fulfillment_OrderBundle_Enum_OrderSize"},"extra_data":{"type":"array","items":{"$ref":"#/components/schemas/ShipMonk_OMS_Notification_ApiResource_ShipmentNotificationExtraDataOutput"}},"routing":{"anyOf":[{"$ref":"#/components/schemas/ShipMonk_OMS_Notification_ApiResource_RoutingOutput"},{"type":"null"}]},"ordered_at":{"anyOf":[{"$ref":"#/components/schemas/ShipMonk_OMS_Notification_ApiResource_DateTimeOutput"},{"type":"string"}]},"shipped_at":{"anyOf":[{"$ref":"#/components/schemas/ShipMonk_OMS_Notification_ApiResource_DateTimeOutput"},{"type":"string"}]},"packages":{"type":"array","items":{"$ref":"#/components/schemas/ShipMonk_OMS_Notification_ApiResource_PackageOutput"}},"pallets":{"type":"array","items":{"$ref":"#/components/schemas/ShipMonk_OMS_Notification_ApiResource_PalletOutput"}},"ship_from":{"anyOf":[{"$ref":"#/components/schemas/ShipMonk_OMS_Notification_ApiResource_ShipFromAddressOutput"},{"type":"null"}]},"ship_to":{"$ref":"#/components/schemas/ShipMonk_OMS_Notification_ApiResource_ShipToAddressOutput"}},"required":["order_key","parent_order_key","order_number","warehouse","items","store_id","carrier","service","master_tracking_number","tracking_link","estimated_shipping_cost","custom_data","carrier_tracking_url","carrier_alpha_code","carrier_trans_method_code","bill_of_lading_number","master_bill_of_lading_number","load_number","authorization_number","order_parts","serial_numbers","order_size","extra_data","routing","ordered_at","shipped_at","packages","pallets","ship_from","ship_to"],"title":"Shipment Notification Output"},"ShipMonk_OMS_Notification_ApiResource_ShipmentNotificationProductLotOutput":{"type":"object","properties":{"sku":{"type":"string"},"quantity":{"type":"integer"},"ordered_quantity":{"type":"integer"},"lot":{"anyOf":[{"$ref":"#/components/schemas/ShipMonk_OMS_Notification_ApiResource_ShipmentNotificationLotOutput"},{"type":"null"}]},"other_potential_lots":{"type":"array","items":{"$ref":"#/components/schemas/ShipMonk_OMS_Notification_ApiResource_ShipmentNotificationLotOutput"}}},"required":["sku","quantity","ordered_quantity","lot","other_potential_lots"],"title":"Shipment Notification Product Lot Output"},"ShipMonk_OMS_Order_Enum_Embroidery_EmbroideryType":{"type":["string"],"enum":["logo","text","text_with_logo","logo_identifier","text_with_symbol"],"title":"Embroidery Type"},"ShipMonk_OMS_Order_Enum_OrderType":{"type":["string"],"enum":["direct_to_consumer","retail","amazon","transfer","removal_liquidation","disposal","bonded_inventory_clearance","work_order"],"title":"Order Type"},"ShipMonk_OMS_Product_Enum_ProductHandlingUnitType":{"type":["string"],"enum":["inner_carton","master_carton","pallet"],"title":"Product Handling Unit Type"},"ShipMonk_OMS_Receiving_ApiResource_PublicApiCartonOutput":{"type":"object","properties":{"carton_key":{"description":"Client-supplied unique key identifying this carton within the receiving; referenced by receiving_lines[].carton_key.","type":"string"},"pallet_key":{"description":"Key of the pallet (from pallets[].pallet_key) on which this carton is placed, or null if the carton is not on a pallet.","type":["string","null"]},"lpns":{"description":"Packaging identifiers attached to this carton (e.g. SSCC barcodes).","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_OMS_Receiving_ApiResource_PublicApiLpnOutput"}},"identifiers":{"description":"Deprecated: Superseded by lpns (same data). Will be removed after consumers migrate.","deprecated":true,"type":"array","items":{"$ref":"#/components/schemas/ShipMonk_OMS_Receiving_ApiResource_PublicApiLpnOutput"}}},"required":["carton_key","pallet_key","lpns","identifiers"],"title":"Carton Output"},"ShipMonk_OMS_Receiving_ApiResource_PublicApiLotControlOutput":{"type":"object","properties":{"lot_number":{"description":"Lot number assigned to the product batch, or null if the lot is identified only by expiration date.","type":["string","null"]},"expiration_date":{"description":"Lot expiration date in ISO 8601 format (YYYY-MM-DD), or null if not applicable.","type":["string","null"],"format":"date"}},"required":["lot_number","expiration_date"],"title":"Lot Control Output"},"ShipMonk_OMS_Receiving_ApiResource_PublicApiLpnOutput":{"type":"object","properties":{"type":{"description":"Type of identifier. Allowed values: SSCC (Serial Shipping Container Code, a GS1 18-digit logistics barcode).","$ref":"#/components/schemas/ShipMonk_OMS_Receiving_Enum_LpnType"},"value":{"description":"The identifier value, formatted according to the rules of the chosen type (e.g. 18 digits for SSCC).","type":"string"}},"required":["type","value"],"title":"Lpn Output"},"ShipMonk_OMS_Receiving_ApiResource_PublicApiPalletOutput":{"type":"object","properties":{"pallet_key":{"description":"Client-supplied unique key identifying this pallet within the receiving; referenced by cartons[].pallet_key and receiving_lines[].loose_units_pallet_key.","type":"string"},"lpns":{"description":"Packaging identifiers attached to this pallet (e.g. SSCC barcodes).","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_OMS_Receiving_ApiResource_PublicApiLpnOutput"}},"identifiers":{"description":"Deprecated: Superseded by lpns (same data). Will be removed after consumers migrate.","deprecated":true,"type":"array","items":{"$ref":"#/components/schemas/ShipMonk_OMS_Receiving_ApiResource_PublicApiLpnOutput"}}},"required":["pallet_key","lpns","identifiers"],"title":"Pallet Output"},"ShipMonk_OMS_Receiving_ApiResource_PublicApiReceivingItemOutput":{"type":"object","properties":{"product":{"description":"The product identified by this receiving item.","$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Crate_ReturnOrReceivingItemProductPublicApiOutput"},"expected_quantity":{"description":"Total number of units of this product expected to be received.","type":"integer"},"received_quantity":{"description":"Total number of units of this product received so far across all batches.","type":"integer"},"receiving_details":{"description":"Per-batch breakdown of received units for this product, including lot information and timestamps.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Crate_PublicApiReceivingItemDetailsOutput"}}},"required":["product","expected_quantity","received_quantity","receiving_details"],"title":"Receiving Item Output"},"ShipMonk_OMS_Receiving_ApiResource_PublicApiReceivingLineOutput":{"type":"object","properties":{"line_key":{"description":"Client-supplied unique key identifying this line within the receiving, or null if none was provided at creation.","type":["string","null"]},"product":{"description":"The product on this receiving line.","$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Crate_ReturnOrReceivingItemProductPublicApiOutput"},"expected_quantity":{"description":"Number of units expected on this line.","type":"integer"},"received_quantity":{"description":"Number of units received on this line so far.","type":"integer"},"lpn":{"description":"Typed License Plate Number for this line ({ type, value }). For cartonised items this mirrors the carton LPN; for loose units on a pallet, the pallet LPN.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_OMS_Receiving_ApiResource_PublicApiLpnOutput"},{"type":"null"}]},"sscc":{"description":"Deprecated: Will be removed on 2026-06-30. Use lpn { type, value } (or cartons[].lpns / pallets[].lpns with type=SSCC) instead. For items placed on a carton, this mirrors the carton's SSCC; for loose items on a pallet, it mirrors the pallet's SSCC. Always returned as 20 digits (GS1 AI \"00\" prefix included).","deprecated":true,"anyOf":[{"type":"string"},{"type":"null"}]},"carton_key":{"description":"Key of the carton (from cartons[].carton_key) on which these units are packed, or null if the units are loose on a pallet. Exactly one of carton_key or loose_units_pallet_key is non-null when the packing hierarchy is used.","type":["string","null"]},"loose_units_pallet_key":{"description":"Key of the pallet (from pallets[].pallet_key) on which these loose units are placed without a carton, or null if the units are packed in a carton. Exactly one of carton_key or loose_units_pallet_key is non-null when the packing hierarchy is used.","type":["string","null"]},"lot":{"description":"Lot/batch tracking data for the units on this line, or null if no lot is tracked.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Crate_ReturnOrReceivingItemLotPublicApiOutput"},{"type":"null"}]}},"required":["line_key","product","expected_quantity","received_quantity","lpn","sscc","carton_key","loose_units_pallet_key","lot"],"title":"Receiving Line Output"},"ShipMonk_OMS_Receiving_ApiResource_PublicApiReceivingOutput":{"type":"object","properties":{"id":{"description":"Server-assigned numeric identifier of the receiving. Use this value to reference the receiving in subsequent API calls.","type":"integer"},"warehouse":{"description":"Code of the warehouse where the goods are being received.","type":"string"},"receiving_key":{"description":"Client-supplied reference (e.g. purchase order number) for the receiving, or null if none was provided at creation.","type":["string","null"]},"asn":{"description":"Advance Shipping Notice (ASN) number, a supplier-provided identifier for the incoming shipment.","type":"string"},"bol_number":{"description":"Bill of Lading (BOL) number from the carrier transport document, or null if not provided.","anyOf":[{"type":"string"},{"type":"null"}]},"supplier_name":{"description":"Name of the supplier sending the goods.","type":"string"},"handling_unit_type":{"description":"Type of handling units used to ship the goods.","$ref":"#/components/schemas/ShipMonk_Warehouse_WarehouseReceiving_Enum_WarehouseReceivingPacking"},"handling_unit_quantity":{"description":"Total number of handling units (as specified by handling_unit_type) in the shipment.","type":"integer"},"estimated_delivery":{"description":"Estimated date when the shipment is expected to arrive at the warehouse, in ISO 8601 format (YYYY-MM-DD).","type":"string"},"description":{"description":"Free-form notes about the receiving, or null if none were provided.","type":["string","null"]},"status":{"description":"Current status of the receiving: awaiting (created, shipment not yet arrived), arrived (shipment received at the warehouse but not yet processed), in_progress (goods being unloaded and counted), received (processing complete).","$ref":"#/components/schemas/ShipMonk_OMS_Receiving_Enum_PublicApiReceivingStatus"},"created_at":{"description":"Timestamp when the receiving record was created, in ISO 8601 format.","type":"string","format":"date-time"},"updated_at":{"description":"Timestamp when the receiving record was last modified, in ISO 8601 format.","type":"string","format":"date-time"},"arrived_at":{"description":"Timestamp when the shipment physically arrived at the warehouse, in ISO 8601 format. Null until arrival.","type":["string","null"],"format":"date-time"},"received_at":{"description":"Timestamp when all goods finished being received and counted, in ISO 8601 format. Null until processing is complete.","type":["string","null"],"format":"date-time"},"items":{"description":"Expected and received quantities aggregated per product across the entire receiving.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_OMS_Receiving_ApiResource_PublicApiReceivingItemOutput"}},"receiving_lines":{"description":"Itemized receiving lines, each linking a product (with optional lot data) to a specific carton or pallet in the packing hierarchy.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_OMS_Receiving_ApiResource_PublicApiReceivingLineOutput"}},"custom_data":{"description":"Arbitrary name/value pairs supplied by client integrations and attached to the receiving.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_CommonBundle_ApiResource_IntegrationDataOutput"}},"cartons":{"description":"Cartons declared on the receiving. Each receiving_lines entry with a non-null carton_key references one of these by carton_key.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_OMS_Receiving_ApiResource_PublicApiCartonOutput"}},"pallets":{"description":"Pallets declared on the receiving. Each carton or loose-units line may reference one of these by pallet_key.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_OMS_Receiving_ApiResource_PublicApiPalletOutput"}}},"required":["id","warehouse","receiving_key","asn","bol_number","supplier_name","handling_unit_type","handling_unit_quantity","estimated_delivery","description","status","created_at","updated_at","arrived_at","received_at","items","receiving_lines","custom_data","cartons","pallets"],"title":"Receiving Output"},"ShipMonk_OMS_Receiving_ApiResource_PublicApiReceivingReceiptItemDetailOutput":{"type":"object","properties":{"line_key":{"description":"Caller-supplied line key of the receiving line this detail belongs to; null if no key was provided.","type":["string","null"]},"received_quantity":{"description":"Number of units received in this detail entry.","type":"integer"},"received_at":{"description":"Timestamp when this batch was received at the warehouse, in ISO 8601 format. Null if not yet received.","type":["string","null"],"format":"date-time"},"lot":{"description":"Lot/batch control information for the received units, or null if the product is not lot-tracked.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_OMS_Receiving_ApiResource_PublicApiLotControlOutput"},{"type":"null"}]}},"required":["line_key","received_quantity","received_at","lot"],"title":"Receiving Receipt Item Detail Output"},"ShipMonk_OMS_Receiving_ApiResource_PublicApiReceivingReceiptItemOutput":{"type":"object","properties":{"product":{"description":"Product associated with this receipt item.","$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Crate_ReturnOrReceivingItemProductPublicApiOutput"},"received_quantity":{"description":"Total number of units received for this product across all detail entries.","type":"integer"},"receiving_details":{"description":"Per-batch breakdown of how many units were received, when, and against which lot.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_OMS_Receiving_ApiResource_PublicApiReceivingReceiptItemDetailOutput"}}},"required":["product","received_quantity","receiving_details"],"title":"Receiving Receipt Item Output"},"ShipMonk_OMS_Receiving_ApiResource_PublicApiReceivingReceiptLineQuantityOutput":{"type":"object","properties":{"line_key":{"description":"Caller-supplied line key of the receiving line this quantity belongs to; null if no key was provided.","type":["string","null"]},"product":{"description":"Product associated with this receiving line.","$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Crate_ReturnOrReceivingItemProductPublicApiOutput"},"received_quantity":{"description":"Number of units received for this receiving line.","type":"integer"},"lot":{"description":"Lot/batch control information for the received units, or null if the product is not lot-tracked.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_OMS_Receiving_ApiResource_PublicApiLotControlOutput"},{"type":"null"}]}},"required":["line_key","product","received_quantity","lot"],"title":"Receiving Receipt Line Quantity Output"},"ShipMonk_OMS_Receiving_ApiResource_PublicApiReceivingReceiptOutput":{"type":"object","properties":{"receipt_id":{"description":"Unique numeric identifier of the receipt.","type":"integer"},"receiving_id":{"description":"Unique numeric identifier of the receiving (the inbound shipment) the receipt was generated for.","type":"integer"},"warehouse":{"description":"Short warehouse code (e.g., CA1) where the goods were received.","type":"string"},"receiving_key":{"description":"Caller-provided reference key of the associated receiving (inbound shipment), or null if none was supplied.","type":["string","null"]},"asn":{"description":"Advance Ship Notice (ASN) number of the associated receiving (inbound shipment).","type":"string"},"receipt_created_at":{"description":"ISO 8601 timestamp indicating when the receipt was created.","type":"string","format":"date-time"},"receipt_completed_at":{"description":"ISO 8601 timestamp indicating when the receipt was completed.","type":"string","format":"date-time"},"items":{"description":"List of received items aggregated by product.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_OMS_Receiving_ApiResource_PublicApiReceivingReceiptItemOutput"}},"receiving_lines":{"description":"Received quantities broken down by receiving line and lot.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_OMS_Receiving_ApiResource_PublicApiReceivingReceiptLineQuantityOutput"}},"custom_data":{"description":"Arbitrary key-value metadata copied from the associated receiving.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_CommonBundle_ApiResource_IntegrationDataOutput"}}},"required":["receipt_id","receiving_id","warehouse","receiving_key","asn","receipt_created_at","receipt_completed_at","items","receiving_lines","custom_data"],"title":"Receiving Receipt Output"},"ShipMonk_OMS_Receiving_Enum_LpnType":{"type":["string"],"enum":["SSCC"],"title":"Lpn Type"},"ShipMonk_OMS_Receiving_Enum_PublicApiReceivingStatus":{"type":["string"],"enum":["awaiting","arrived","in_progress","received"],"title":"Receiving Status"},"ShipMonk_OMS_Receiving_Enum_ReceivingCategory":{"type":["string"],"enum":["purchase_order_asn","inventory_transfer","wholesale_order_return","special_projects","subscription_box_receiving","bonded_inventory","package_forwarding"],"title":"Receiving Category"},"ShipMonk_OMS_RequiredLabels_Enum_PackingLabelType":{"type":["string"],"enum":["shipmonk_pack_list_order_level","shipmonk_pack_list_carton_level","retailer_packing_slip_order_level","shipmonk_carton_label","shipmonk_pallet_label","gs1_label","shipmonk_gs1","customized_carton_labels","liquid_iv_packing_list","custom_pack_list_order_level","special_instructions"],"title":"Packing Label Type"},"ShipMonk_OMS_RequiredLabels_Enum_RequiredLabelDataSource":{"type":["string"],"enum":["internal","third-party-after-shipment-notification"],"title":"Required Label Data Source"},"ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderAdditionalDocumentInput":{"type":"object","properties":{"name":{"description":"Human-readable name of the document, shown in reports and to warehouse staff.","type":"string","maxLength":255},"url":{"description":"Publicly accessible URL of the PDF document to print and enclose with the shipment.","type":"string","maxLength":2048}},"required":["name","url"],"title":"Create Or Update Order Additional Document Input"},"ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderAttributeInput":{"type":"object","properties":{"name":{"description":"Key identifying the custom attribute; must be unique within the order's attributes array.","type":"string","maxLength":255},"value":{"description":"Value paired with the attribute `name` on the order.","type":"string","maxLength":255}},"required":["name","value"],"title":"Create Or Update Order Attribute Input"},"ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderB2BAttributeInput":{"type":"object","properties":{"name":{"description":"Name (key) of the B2B attribute; should be unique within the item's b2b_attributes list.","type":"string","maxLength":255},"value":{"anyOf":[{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"string"},{"type":"array"}]}},"required":["name","value"],"title":"Create Or Update Order B2 B Attribute Input"},"ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderCartonLabelInput":{"type":"object","properties":{"type":{"description":"Type of carton label to generate. Allowed values: `gs1` (standard GS1-128 label), `shipmonk_gs1` (ShipMonk-managed GS1 label), `customized_carton_labels` (retailer template stored with ShipMonk), `custom` (label PDF supplied via `url`).","$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Enum_CartonLabelType","default":"custom"},"name":{"description":"Human-readable name of the carton label template; used to identify the label in reports.","type":["string","null"],"maxLength":255,"default":null},"url":{"description":"Publicly accessible URL of the carton label PDF; required when `type` is `custom`.","type":["string","null"],"maxLength":2048,"default":null},"shipping_data_required":{"description":"If true, carrier tracking and address data must be merged onto the carton label before printing.","type":"boolean","default":false},"approved_shipment_id_number_required":{"description":"If true, the retailer's approved shipment ID (e.g., an ASN number returned after the shipment notice) must be printed on the label. The order will not ship until the ID is supplied.","type":"boolean","default":false},"data_source":{"description":"Where the label data comes from. Allowed values: `internal` (data already supplied with the order), `third-party-after-shipment-notification` (label is rendered after a third party returns data following the shipment notification).","$ref":"#/components/schemas/ShipMonk_OMS_RequiredLabels_Enum_RequiredLabelDataSource","default":"internal"}},"required":[],"title":"Create Or Update Order Carton Label Input"},"ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderCustomDataInput":{"type":"object","properties":{"name":{"description":"Key (name) of the custom data entry; should be unique within the item's custom_data list.","type":"string","minLength":2,"maxLength":255},"value":{"description":"Value stored under the corresponding custom_data name.","type":"string"}},"required":["name","value"],"title":"Create Or Update Order Custom Data Input"},"ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderInput":{"type":"object","properties":{"store_id":{"description":"Identifier of the store the order belongs to.","type":"integer","minimum":1,"example":123456},"order_number":{"description":"Customer-facing order identifier (e.g. shown on the packing slip). Uniqueness is recommended but not enforced. Immutable after creation.","type":"string","maxLength":255,"example":"Order-123"},"order_key":{"description":"Stable external identifier used to associate this order on subsequent updates; must be unique per order and acts as the upsert key.","type":"string","maxLength":255,"example":"327b5abd-017a-4504-a50d-54f1cea80269"},"items":{"description":"Line items to be fulfilled in the order.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderItemInput"}},"ship_to":{"description":"Recipient's shipping destination address; used to generate the shipping label and select the carrier service.","$ref":"#/components/schemas/ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderShipToInput"},"requested_shipping_service":{"description":"Carrier-specific shipping service code requested for the shipment (e.g., 'fedex_ground', 'usps_priority'); the warehouse uses it to choose the carrier service when generating the label.","type":"string","maxLength":255},"ordered_at":{"description":"ISO 8601 timestamp when the order was originally placed in the source system.","type":"string","format":"date-time","example":"2025-07-24 14:53:00"},"order_status":{"description":"Current status of the order. Allowed values: `unfulfilled` (ready to be picked/shipped), `fulfilled` (already shipped externally), `cancelled` (will not be shipped), `onHold` (paused, will not be picked until released).","$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Type_OrderSyncOrderStatus"},"attributes":{"description":"Free-form key/value pairs stored on the order, used for custom development.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderAttributeInput"},"default":[]},"trading_partner":{"description":"Name of the retailer or trading partner for B2B/EDI orders; required to apply the partner's routing and labeling rules.","type":["string","null"],"maxLength":255,"default":null},"order_type":{"description":"Order classification used by the warehouse (e.g., 'b2b', 'b2c', 'wholesale'). Contact support for the list of supported types for your account; defaults to a standard B2C order when omitted.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_OMS_Order_Enum_OrderType"},{"type":"null"}],"default":null},"customer_email":{"description":"Recipient email address forwarded to the carrier for delivery notifications.","type":["string","null"],"maxLength":255,"default":null},"shipping_paid":{"description":"Amount the customer paid for shipping, expressed in the order's `currency_code`. Informational only; does not affect rated postage.","type":["number","null"],"format":"double","minimum":0,"default":null},"taxes_paid":{"description":"Tax amount the customer paid, in the order's `currency_code`. Informational only; used for customs paperwork on international shipments.","type":["number","null"],"format":"double","minimum":0,"default":null},"currency_code":{"description":"ISO 4217 three-letter currency code for `shipping_paid`, `taxes_paid`, and item prices (e.g., 'USD', 'EUR').","type":["string","null"],"maxLength":3,"default":"USD"},"references":{"description":"External identifiers (e.g., PO number, marketplace order ID) linking this order back to upstream systems; informational only.","type":"array","items":{"$ref":"#/components/schemas/Fulfillment_AccountApiBundle_Input_Order_OrderReferenceInput"},"default":[]},"customer_notes":{"description":"Notes provided by the buyer (e.g., delivery preferences). Stored on creation only; subsequent updates are ignored once a value is set.","type":["string","null"],"maxLength":65535,"default":null},"internal_notes":{"description":"Notes for internal warehouse staff, not shown to the buyer. Stored on creation only; ignored on subsequent updates.","type":["string","null"],"maxLength":65535,"default":null},"warehouse":{"description":"Identifier of the warehouse that must fulfill this order (e.g., 'FL1', 'CA1'). Use the codes provided by your account manager; omit to let the system pick the best warehouse.","type":["string","null"],"maxLength":255,"default":null,"example":"PA1"},"gift_message":{"description":"Message printed on a gift note included with the shipment. Stored on creation only; ignored on subsequent updates.","type":["string","null"],"maxLength":65535,"default":null},"gift_from":{"description":"Sender name printed on the gift note alongside `gift_message`.","type":["string","null"],"maxLength":255,"default":null},"custom_data":{"description":"Free-form key/value metadata stored on the order; not interpreted by fulfillment logic and returned as-is in order reads.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderCustomDataInput"},"default":[]},"b2b_attributes":{"description":"B2B-specific attributes (e.g., ASN, routing instructions) used when fulfilling retailer orders. Contact api@shipmonk.com to enable B2B order processing on your account before sending these.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderB2BAttributeInput"},"default":[]},"submit_at":{"description":"ISO 8601 timestamp at which the order should be released to the warehouse for picking. Until this time the order is held; omit to release immediately.","type":["string","null"],"format":"date-time","default":null,"example":"2025-07-24 14:53:00"},"special_requirements":{"description":"Optional bundle of special handling requirements (packing slip, carton labels, custom dates, pre-generated shipping label, etc.) to apply to this order.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderSpecialRequirementsInput"},{"type":"null"}],"default":null},"recipient_tax_id":{"description":"Recipient's tax identifier (e.g., VAT, EORI) required for customs clearance on international shipments.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderTaxIdInput"},{"type":"null"}],"default":null},"minimum_shelf_life_days":{"description":"Minimum remaining shelf life (in days from the ship date) required for every lot-controlled item in the order; omit to accept any shelf life.","type":["integer","null"],"exclusiveMinimum":0,"default":null}},"required":["store_id","order_number","order_key","items","ship_to","requested_shipping_service","ordered_at","order_status"],"title":"Create Or Update Order Input"},"ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderItemB2BAttributeInput":{"type":"object","properties":{"name":{"description":"Name (key) of the B2B attribute; should be unique within the item's b2b_attributes list.","type":"string","maxLength":255},"value":{"description":"Value of the B2B attribute identified by the sibling `name` (free-form string).","type":"string","maxLength":255}},"required":["name","value"],"title":"Create Or Update Order Item B2 B Attribute Input"},"ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderItemEmbroiderySpecialInstructionInput":{"type":"object","properties":{"type":{"type":["string"],"enum":["embroidery"]},"values":{"description":"List of embroidery instruction values","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderItemEmbroiderySpecialInstructionValueInput"}}},"required":["type","values"],"title":"Create Or Update Order Item Embroidery Special Instruction Input"},"ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderItemEmbroiderySpecialInstructionValueInput":{"type":"object","properties":{"type":{"description":"Type of embroidery","$ref":"#/components/schemas/ShipMonk_OMS_Order_Enum_Embroidery_EmbroideryType"},"location":{"description":"Location on the product where the embroidery should be placed","type":"string","maxLength":255},"color":{"description":"Thread color for the embroidery","type":["string","null"],"maxLength":255,"default":null},"font":{"description":"Font for embroidered text","type":["string","null"],"maxLength":255,"default":null},"line1":{"description":"First line of embroidery text","type":["string","null"],"maxLength":25,"default":null},"line2":{"description":"Second line of embroidery text","type":["string","null"],"maxLength":25,"default":null},"line3":{"description":"Third line of embroidery text","type":["string","null"],"maxLength":25,"default":null},"logo_url":{"description":"URL of the logo file to be embroidered on the product","type":["string","null"],"maxLength":2048,"default":null},"file_identifier":{"description":"File identifier for the embroidery design","type":["string","null"],"maxLength":255,"default":null},"symbol":{"description":"Symbol identifier for embroidery designs","type":["string","null"],"maxLength":255,"default":null},"symbol_color":{"description":"Color of the embroidered symbol","type":["string","null"],"maxLength":255,"default":null}},"required":["type","location"],"title":"Create Or Update Order Item Embroidery Special Instruction Value Input"},"ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderItemInput":{"type":"object","properties":{"sku":{"description":"Marketplace Stock Keeping Unit (SKU) of the product; must match an existing product.","type":"string","maxLength":255},"quantity":{"description":"Number of units of this SKU on the order line; must be a positive integer.","type":"integer","minimum":0,"exclusiveMaximum":1000000},"line_key":{"description":"Optional external key identifying this line item, useful for matching updates against the source system's line.","type":["string","null"],"maxLength":255,"default":null},"name":{"description":"Display name for the product on this line. Optional; immutable after the item is created.","type":["string","null"],"maxLength":65536,"default":null},"price":{"description":"Per-unit price of the product in the order currency. Optional; immutable after the item is created.","type":["number","null"],"format":"double","default":null},"packing_group":{"description":"Optional group identifier; items sharing the same packing_group.key should be packed together in the same parcel.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderItemPackingGroupInput"},{"type":"null"}],"default":null},"custom_data":{"description":"Optional custom name/value pairs attached to the line item for integration metadata. Immutable after the item is created.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderCustomDataInput"},"default":[]},"b2b_attributes":{"description":"Optional B2B-specific attributes (e.g. retailer compliance fields) attached to the line. Immutable after the item is created.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderItemB2BAttributeInput"},"default":[]},"special_instructions":{"description":"Special handling instructions to apply to this line item; omit when none are needed.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderItemSpecialInstructionInput"},"default":[]},"image_url":{"description":"Publicly accessible image URL of the product. Set on creation only; updates are ignored once the item exists.","type":["string","null"],"maxLength":2048,"default":null},"lot_requirements":{"description":"Lot/expiration constraints that pickers must honor for this item. Can only be set before the order is submitted to the warehouse; later updates are ignored.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderItemLotRequirementsInput"},{"type":"null"}],"default":null}},"required":["sku","quantity"],"title":"Create Or Update Order Item Input"},"ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderItemLotControlInput":{"type":"object","properties":{"lot_number":{"description":"Specific lot number that must be picked for this item; omit to allow any lot.","type":["string","null"],"maxLength":255,"default":null},"expiration_date":{"description":"Required expiration date of the picked lot in ISO 8601 (YYYY-MM-DD) format; omit to allow any expiration.","type":["string","null"],"format":"date","default":null}},"required":[],"title":"Create Or Update Order Item Lot Control Input"},"ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderItemLotRequirementsInput":{"type":"object","properties":{"minimum_shelf_life_days":{"description":"Minimum remaining shelf life (in days from the ship date) that any allocated lot must have. Omit to accept any shelf life.","type":["integer","null"],"exclusiveMinimum":0,"default":null},"lot_controls":{"description":"Specific lots (by lot number and/or expiration date) that must be used to fulfill this item. Leave empty to allow any qualifying lot.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderItemLotControlInput"},"default":[]}},"required":[],"title":"Create Or Update Order Item Lot Requirements Input"},"ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderItemPackingGroupInput":{"type":"object","properties":{"key":{"description":"Stable key identifying the packing group; items with the same key are packed together.","type":"string","maxLength":255},"name":{"description":"Optional human-readable name for the packing group, shown to warehouse staff.","type":["string","null"],"maxLength":255,"default":null}},"required":["key"],"title":"Create Or Update Order Item Packing Group Input"},"ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderItemSpecialInstructionInput":{"oneOf":[{"$ref":"#/components/schemas/ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderItemEmbroiderySpecialInstructionInput"}],"discriminator":{"propertyName":"type","mapping":{"embroidery":"#/components/schemas/ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderItemEmbroiderySpecialInstructionInput"}},"title":"Create Or Update Order Item Special Instruction Input"},"ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderPackingSlipInput":{"type":"object","properties":{"type":{"description":"Packing slip template to use. Allowed values: `retailer` (retailer-supplied template stored with ShipMonk).","$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_Enum_OrderLevelPackingSlipType","default":"retailer"},"name":{"description":"Human-readable name of the packing slip template; used to identify it in reports.","type":["string","null"],"maxLength":255,"default":null},"shipping_data_required":{"description":"If true, carrier tracking and address data must be merged onto the packing slip before printing.","type":"boolean","default":false},"approved_shipment_id_number_required":{"description":"If true, the retailer's approved shipment ID (e.g., an ASN number returned after the shipment notice) must be printed on the label. The order will not ship until the ID is supplied.","type":"boolean","default":false}},"required":[],"title":"Create Or Update Order Packing Slip Input"},"ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderShipToInput":{"type":"object","properties":{"name":{"description":"Full name of the recipient as it should appear on the shipping label.","type":["string","null"],"maxLength":255,"default":null},"company":{"description":"Recipient's company name as it should appear on the shipping label; omit for residential deliveries.","type":["string","null"],"maxLength":255,"default":null},"street1":{"description":"First line of the recipient's street address (e.g., house number and street).","type":["string","null"],"maxLength":255,"default":null},"street2":{"description":"Second line of the recipient's street address (apartment, suite, or unit); omit if not applicable.","type":["string","null"],"maxLength":255,"default":null},"state":{"description":"State, province, or region; use the ISO 3166-2 subdivision code where one exists (e.g., 'CA' for California).","type":["string","null"],"maxLength":255,"default":null},"city":{"description":"City of the recipient's address.","type":["string","null"],"maxLength":255,"default":null},"zip":{"description":"Postal or ZIP code of the recipient's address.","type":["string","null"],"maxLength":255,"default":null},"country_code":{"description":"ISO 3166-1 alpha-2 country code of the recipient (e.g., 'US', 'GB').","type":["string","null"],"maxLength":255,"default":null},"phone":{"description":"Recipient phone number in E.164 format; used by carriers for delivery contact.","type":["string","null"],"maxLength":255,"default":null}},"required":[],"title":"Create Or Update Order Ship To Input"},"ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderShippingLabelInput":{"type":"object","properties":{"url":{"description":"Publicly accessible URL pointing to the pre-generated shipping label PDF or PNG.","type":"string","maxLength":2048}},"required":["url"],"title":"Create Or Update Order Shipping Label Input"},"ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderSpecialRequirementsInput":{"type":"object","properties":{"special_instruction":{"description":"Free-form instructions shown to warehouse staff while processing the order (e.g., 'fragile, do not stack').","type":["string","null"],"pattern":"\\S","default":null},"pack_list_required":{"description":"If true, a packing list document is enclosed in the shipment. Stored on creation only; ignored on subsequent updates.","type":"boolean","default":false},"carton_labels":{"description":"Carton labels (e.g., GS1, retailer-customized) that must be printed and affixed to each carton during packing.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderCartonLabelInput"},"default":[]},"order_level_packing_slip":{"description":"Configuration of the packing slip generated for the whole order (as opposed to per-carton); omit to use the account default.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderPackingSlipInput"},{"type":"null"}],"default":null},"shipping_label":{"description":"Pre-generated shipping label supplied by the merchant; when present, the warehouse uses this label instead of buying postage.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderShippingLabelInput"},{"type":"null"}],"default":null},"additional_documents":{"description":"Extra documents (e.g., commercial invoices, MSDS, certificates) that must be printed and enclosed with the shipment.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderAdditionalDocumentInput"},"default":[]},"shipping_date":{"description":"Requested ship-by date (single date or range, in ISO 8601). Warehouse will attempt to ship within this window.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_AccountApiBundle_Input_Order_CreateUpdateFulfillmentRequirements_SpecialRequirementsDatesInput"},{"type":"null"}],"default":null},"delivery_date":{"description":"Required delivery date (single date or range, in ISO 8601). Warehouse picks a service expected to arrive within this window.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_AccountApiBundle_Input_Order_CreateUpdateFulfillmentRequirements_SpecialRequirementsDatesInput"},{"type":"null"}],"default":null},"cancel_date":{"description":"ISO 8601 date after which the order should be auto-cancelled if it has not yet shipped; omit to disable auto-cancellation.","type":["string","null"],"format":"date","default":null},"fulfillment_strategy":{"description":"Strategy used to allocate inventory and split shipments. Refer to the API documentation for supported values; omit to use the account default.","anyOf":[{"$ref":"#/components/schemas/Fulfillment_OrderBundle_Enum_FulfillmentStrategy"},{"type":"null"}],"default":null}},"required":[],"title":"Create Or Update Order Special Requirements Input"},"ShipMonk_PublicApi_Order_OrderCreateOrUpdate_CreateOrUpdateOrderTaxIdInput":{"type":"object","properties":{"type":{"description":"Type of tax identifier supplied in `value`. Allowed: `VAT`, `IOSS`, `TIN`, `EIN`, `EORI`, `ARN`, `RFC`, `CPF`, `CNPJ`, `PCCC`.","$ref":"#/components/schemas/Fulfillment_UserBundle_Enum_TaxIdType"},"value":{"description":"The tax identifier string itself, formatted according to the rules of the chosen `type` and `issuing_country_id`.","type":"string","maxLength":255},"issuing_country_id":{"description":"ISO 3166-1 alpha-2 country code of the authority that issued the tax ID (e.g., 'DE' for a German VAT number).","type":"string","minLength":2,"maxLength":2}},"required":["type","value","issuing_country_id"],"title":"Create Or Update Order Tax Id Input"},"ShipMonk_PublicApi_Product_ProductCreate_CreateProductInput":{"type":"object","properties":{"product_key":{"description":"Unique identifier for the product in your external system. Must be unique across all your products.","type":"string","minLength":3,"maxLength":255},"sku":{"description":"Stock Keeping Unit (SKU) identifying the product. Must be unique across all active products in your account.","type":"string","minLength":3,"maxLength":255},"name":{"description":"Human-readable product name displayed in the UI and on documents.","type":"string","minLength":3,"maxLength":255},"required_packaging":{"description":"Minimum packaging type required to ship this product: poly_mailer, bubble_mailer, box, slap_a_label (label applied directly), or custom.","$ref":"#/components/schemas/Fulfillment_InventoryBundle_Enum_PackagingType"},"fragile":{"description":"Whether the product requires fragile handling during fulfillment. If true, required_packaging must be box.","type":"boolean"},"replacement_cost":{"description":"Cost to replace the product, used for insurance and claims. Must be positive, in the currency given by currency_code.","type":"number","format":"double","exclusiveMinimum":0},"customs_declaration_value":{"description":"Declared customs value per unit, used to calculate duties and taxes on international shipments. Must be positive, in the currency given by currency_code.","type":"number","format":"double","exclusiveMinimum":0},"country_of_origin":{"description":"Country of origin as an ISO 3166-1 alpha-2 code (e.g. US, DE, CN), used on customs documentation for international shipments.","type":"string","minLength":2,"maxLength":2},"barcodes":{"description":"Barcodes associated with the product (e.g. UPC, EAN, ISBN). Each barcode must be 1-255 characters; pass an empty array if none.","type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"dimensions_in":{"description":"Physical product dimensions in inches. Omit if dimensions are unknown.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_PublicApi_Product_ProductCreate_DimensionsInInput"},{"type":"null"}],"default":null},"weight_lb":{"description":"Product weight in pounds (decimal). Must be positive. Omit or set null if weight is unknown.","type":["number","null"],"format":"double","exclusiveMinimum":0,"default":null},"currency_code":{"description":"ISO 4217 currency code (e.g. USD, EUR) for replacement_cost and customs_declaration_value. Defaults to USD.","type":"string","minLength":3,"maxLength":3,"default":"USD"},"hs_code":{"description":"Default Harmonized System (HS) code used on customs declarations when no region-specific code in hs_codes matches. Max 255 characters.","type":["string","null"],"minLength":1,"maxLength":255,"default":null},"hs_codes":{"description":"Region-specific Harmonized System (HS) codes used for customs classification per destination region. Takes precedence over hs_code when a matching region is found.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Product_ProductCreate_IntegrationHsCodePerRegionInput"},"default":[]},"image_url":{"description":"Publicly accessible URL of the product image. Must be a valid URL and unique across all your products.","type":["string","null"],"default":null},"custom_data":{"description":"Custom key/value metadata to attach to the product, typically used for integration-specific data.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Product_ProductCreate_IntegrationCustomDataItemInput"},"default":[]},"product_handling_units":{"description":"List of handling units (inner carton, master carton, pallet) describing the product's packaging hierarchy used for receiving and storage. Omit if the product ships as individual units only.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Product_ProductCreate_ProductHandlingUnitInput"},"default":[]},"lot_control_settings":{"description":"Lot control settings specifying whether lot number and/or expiration date tracking is required for this product. Provide for products that must be tracked by batch or expiration.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_PublicApi_Product_ProductCreate_IntegrationProductLotControlSettingInput"},{"type":"null"}],"default":null}},"required":["product_key","sku","name","required_packaging","fragile","replacement_cost","customs_declaration_value","country_of_origin","barcodes"],"title":"Create Product Input"},"ShipMonk_PublicApi_Product_ProductCreate_DimensionsInInput":{"type":"object","properties":{"width":{"description":"Product width in inches. Must be positive.","type":"number","format":"double","exclusiveMinimum":0},"height":{"description":"Product height in inches. Must be positive.","type":"number","format":"double","exclusiveMinimum":0},"length":{"description":"Product length in inches. Must be positive.","type":"number","format":"double","exclusiveMinimum":0}},"required":["width","height","length"],"title":"Dimensions In Input"},"ShipMonk_PublicApi_Product_ProductCreate_IntegrationCustomDataItemInput":{"type":"object","properties":{"name":{"description":"Key of the custom data item. Must be 2-255 characters.","type":"string","minLength":2,"maxLength":255},"value":{"description":"Value of the custom data item. Maximum 65536 characters.","type":"string","maxLength":65536}},"required":["name","value"],"title":"Integration Custom Data Item Input"},"ShipMonk_PublicApi_Product_ProductCreate_IntegrationHsCodePerRegionInput":{"type":"object","properties":{"hs_code":{"description":"Harmonized System (HS) code for customs classification. Must be 1-255 characters.","type":"string","minLength":1,"maxLength":255},"region":{"description":"Destination region this HS code applies to: us, uk, or eu.","$ref":"#/components/schemas/ShipMonk_OMS_HsCode_Enum_HsCodeRegion"}},"required":["hs_code","region"],"title":"Integration Hs Code Per Region Input"},"ShipMonk_PublicApi_Product_ProductCreate_IntegrationProductLotControlSettingInput":{"type":"object","properties":{"is_lot_number_required":{"description":"When true, a lot number must be captured every time this product is received into inventory.","type":"boolean"},"is_expiration_date_required":{"description":"When true, an expiration date must be captured every time this product is received into inventory.","type":"boolean"},"is_labeled_with_expiration_date_only":{"description":"When true, the product label shows only the expiration date (without the lot number). Can only be enabled when both is_lot_number_required and is_expiration_date_required are true.","type":"boolean","default":false}},"required":["is_lot_number_required","is_expiration_date_required"],"title":"Integration Product Lot Control Setting Input"},"ShipMonk_PublicApi_Product_ProductCreate_ProductHandlingUnitInput":{"type":"object","properties":{"type":{"description":"Type of the handling unit. Allowed values: inner_carton, master_carton, pallet.","$ref":"#/components/schemas/ShipMonk_OMS_Product_Enum_ProductHandlingUnitType"},"weight_lb":{"description":"Weight of the handling unit in pounds; must be positive. Provide when known to support shipping and storage calculations.","type":["number","null"],"format":"double","exclusiveMinimum":0,"default":null},"dimensions_in":{"description":"Physical dimensions of the handling unit in inches. Provide when known to support shipping and storage calculations.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_PublicApi_Product_ProductCreate_DimensionsInInput"},{"type":"null"}],"default":null},"count":{"description":"Number of individual product units contained in this handling unit. Must be a positive integer.","type":["integer","null"]}},"required":["type","count"],"title":"Product Handling Unit Input"},"ShipMonk_PublicApi_Receiving_ReceivingCreateOrUpdate_CartonInput":{"type":"object","properties":{"carton_key":{"description":"Client-supplied key that uniquely identifies this carton within the request; used by other entries (e.g. items) to reference it.","type":"string","maxLength":255},"pallet_key":{"description":"Optional reference to a pallet_key in the pallets list, indicating this carton is stacked on that pallet. Omit if the carton is loose.","type":["string","null"],"maxLength":255,"default":null},"lpns":{"description":"Typed License Plate Numbers attached to this carton. At most one LPN per type.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Receiving_ReceivingCreateOrUpdate_LpnInput"},"default":[]},"identifiers":{"description":"DEPRECATED — use lpns instead; kept for back-compat and removed after consumers migrate. When both are sent, lpns wins. At most one per type.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Receiving_ReceivingCreateOrUpdate_LpnInput"},"default":[]}},"required":["carton_key"],"title":"Carton Input"},"ShipMonk_PublicApi_Receiving_ReceivingCreateOrUpdate_CreateOrUpdateReceivingInput":{"type":"object","properties":{"warehouse":{"description":"Code of the warehouse where the goods will be received. Determines which facility processes the shipment.","type":"string","maxLength":255,"example":"PA1"},"asn":{"description":"Advance Shipping Notice (ASN) number, a supplier-provided identifier for the incoming shipment. Used as the natural key for upserting the receiving.","type":"string","maxLength":255,"example":"ASN-12345"},"supplier_name":{"description":"Name of the supplier sending the goods.","example":"Acme Supplier","type":"string","maxLength":255},"estimated_delivery":{"description":"Estimated date when the shipment is expected to arrive at the warehouse, in ISO 8601 format (YYYY-MM-DD).","type":"string","format":"date"},"handling_unit_type":{"description":"Type of handling unit used to ship the goods.","$ref":"#/components/schemas/ShipMonk_Warehouse_WarehouseReceiving_Enum_WarehouseReceivingPacking"},"items":{"description":"Line items expected in this receiving, one entry per product (and lot, if tracked).","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Receiving_ReceivingCreateOrUpdate_ReceivingItemInput"}},"handling_unit_quantity":{"description":"Total number of handling units (as specified by handling_unit_type) in the shipment. Omit or pass null if unknown.","example":10,"type":["integer","null"],"minimum":0,"default":null},"receiving_key":{"description":"Optional client-supplied reference (e.g. purchase order number) for this receiving. Stored as-is and returned on subsequent reads.","type":["string","null"],"maxLength":255,"default":null,"example":"key-123"},"description":{"description":"Free-text description of the shipment. Optional; use to attach human-readable context such as supplier remarks or handling notes.","example":"Spring collection shipment","type":["string","null"],"default":null},"bol_number":{"description":"Bill of lading (BoL) number from the carrier's contract of carriage; optional, supply when the inbound shipment has one for cross-referencing.","example":"BOL-9876","type":["string","null"],"maxLength":255,"default":null},"category":{"description":"Optional classification of the receiving (e.g. standard, transfer, return). Omit if no specific category applies.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_OMS_Receiving_Enum_ReceivingCategory"},{"type":"null"}],"default":null},"custom_data":{"description":"Optional list of custom name/value pairs to attach arbitrary metadata to the receiving for reporting or integration use.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Receiving_ReceivingCreateOrUpdate_ReceivingCustomDataItemInput"},"default":[]},"cartons":{"description":"Cartons in the packing hierarchy (equivalent to EDI 856 Pack level). Each carton has a unique carton_key and may reference a pallet. Absent, null, or [] all normalize to an empty list.","type":["array","null"],"items":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Receiving_ReceivingCreateOrUpdate_CartonInput"},"default":null},"pallets":{"description":"Pallets in the packing hierarchy (equivalent to EDI 856 Tare level). Each pallet has a unique pallet_key referenced by cartons. Absent, null, or [] all normalize to an empty list.","type":["array","null"],"items":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Receiving_ReceivingCreateOrUpdate_PalletInput"},"default":null},"tracking_numbers":{"description":"Tracking numbers of packets in this receiving. When omitted on update, the existing tracking numbers are left untouched. When provided as an empty list, all tracking numbers are removed. When provided with values, the existing tracking numbers are replaced with the new list.","type":["array","null"],"items":{"type":"string"},"default":null}},"required":["warehouse","asn","supplier_name","estimated_delivery","handling_unit_type","items"],"title":"Create Or Update Receiving Input"},"ShipMonk_PublicApi_Receiving_ReceivingCreateOrUpdate_LpnInput":{"type":"object","properties":{"type":{"description":"Identifier type. Currently only SSCC is supported.","$ref":"#/components/schemas/ShipMonk_OMS_Receiving_Enum_LpnType"},"value":{"description":"Identifier value. For type=SSCC, must be a valid GS1 SSCC — 18 digits or 20 digits with leading \"00\"; stored and returned as 20 digits.","type":"string","maxLength":255}},"required":["type","value"],"title":"Lpn Input"},"ShipMonk_PublicApi_Receiving_ReceivingCreateOrUpdate_PalletInput":{"type":"object","properties":{"pallet_key":{"description":"Client-supplied key that uniquely identifies this pallet within the request; referenced by cartons.pallet_key.","type":"string","maxLength":255},"lpns":{"description":"Typed License Plate Numbers attached to this pallet. At most one LPN per type.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Receiving_ReceivingCreateOrUpdate_LpnInput"},"default":[]},"identifiers":{"description":"DEPRECATED — use lpns instead; kept for back-compat and removed after consumers migrate. When both are sent, lpns wins. At most one per type.","type":"array","items":{"$ref":"#/components/schemas/ShipMonk_PublicApi_Receiving_ReceivingCreateOrUpdate_LpnInput"},"default":[]}},"required":["pallet_key"],"title":"Pallet Input"},"ShipMonk_PublicApi_Receiving_ReceivingCreateOrUpdate_ReceivingCustomDataItemInput":{"type":"object","properties":{"name":{"description":"Name (key) of the custom metadata entry; should be unique within the receiving's custom_data list.","example":"po_number","type":"string","minLength":2,"maxLength":255},"value":{"description":"Value stored under the corresponding custom_data name.","example":"PO-98765","type":"string","maxLength":65536}},"required":["name","value"],"title":"Receiving Custom Data Item Input"},"ShipMonk_PublicApi_Receiving_ReceivingCreateOrUpdate_ReceivingItemInput":{"type":"object","properties":{"sku":{"description":"Stock Keeping Unit (SKU), the client's unique product code.","type":"string"},"expected_quantity":{"description":"Number of units expected on this line; must be greater than 0.","example":50,"type":"integer","exclusiveMinimum":0},"barcode":{"description":"Barcode used to identify the product (e.g. UPC, EAN). Required if the product cannot be resolved by other means; must match an existing product's barcode.","example":"0123456789012","type":["string","null"],"maxLength":255,"default":null},"lot":{"description":"Lot/batch tracking data for this line. Provide when the product is lot-tracked; omit or pass null otherwise.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_PublicApi_Receiving_ReceivingCreateOrUpdate_ReceivingItemLotInput"},{"type":"null"}],"default":null},"line_key":{"description":"Optional client-supplied key uniquely identifying this line within the receiving. Required when using the packing-hierarchy fields (carton_key or loose_units_pallet_key); must be unique across items in this request.","example":"LINE-001","type":["string","null"],"default":null},"sscc":{"description":"DEPRECATED — will be removed on 2026-06-30. Use lpn { type, value } instead. Silently ignored when carton_key or loose_units_pallet_key is set. Accepts 18-digit GS1 SSCC or 20-digit form with leading \"00\"; stored and returned as 20 digits.","type":["string","null"],"minLength":18,"maxLength":20,"pattern":"^(00)?\\d{18}$","default":null},"lpn":{"description":"Typed License Plate Number attached to this item ({ type, value }). Preferred over the deprecated sscc field. Silently ignored when carton_key or loose_units_pallet_key is set.","anyOf":[{"$ref":"#/components/schemas/ShipMonk_PublicApi_Receiving_ReceivingCreateOrUpdate_LpnInput"},{"type":"null"}],"default":null},"carton_key":{"description":"Key referencing a carton in cartons[].carton_key, indicating these units are packed in that carton. Exactly one of carton_key or loose_units_pallet_key must be non-null when using the packing-hierarchy fields.","type":["string","null"],"maxLength":255,"default":null},"loose_units_pallet_key":{"description":"Key referencing a pallet in pallets[].pallet_key, indicating these units sit loose on that pallet (no carton). Exactly one of carton_key or loose_units_pallet_key must be non-null when using the packing-hierarchy fields.","type":["string","null"],"maxLength":255,"default":null}},"required":["sku","expected_quantity"],"title":"Receiving Item Input"},"ShipMonk_PublicApi_Receiving_ReceivingCreateOrUpdate_ReceivingItemLotInput":{"type":"object","properties":{"lot_number":{"description":"Supplier-assigned lot/batch number. Pass null if unknown.","example":"LOT-2025-001","type":["string","null"],"default":null},"expiration_date":{"description":"Lot expiration date in ISO 8601 format (YYYY-MM-DD). Pass null if the product has no expiration.","type":["string","null"],"format":"date","default":null}},"required":[],"title":"Receiving Item Lot Input"},"ShipMonk_Warehouse_Returns_Enum_ReturnEntitySource":{"type":["string"],"enum":["shipmonk","loop","returnly","deposco","happy_returns_loop","happy_returns"],"title":"Return Entity Source"},"ShipMonk_Warehouse_Returns_Enum_ReturnItemFinalDisposition":{"type":["string"],"enum":["reworked","returned_to_inventory","return_to_merchant","dispose","donate","other"],"title":"Return Item Final Disposition"},"ShipMonk_Warehouse_Returns_Enum_ReturnItemStatus":{"type":["string"],"enum":["received_back_into_inventory","damaged_not_resellable"],"title":"Return Item Status"},"ShipMonk_Warehouse_Returns_Enum_ReturnReason":{"type":["string"],"enum":["reason_exchange","reason_changed_mind","reason_undeliverable","reason_unknown","reason_incorrect_product"],"title":"Return Reason"},"ShipMonk_Warehouse_Returns_Enum_ReturnStatus":{"type":["string"],"enum":["status_created","in_progress","en_route","returned","arrived","not_arrived","grading_completed"],"title":"Return Status"},"ShipMonk_Warehouse_Returns_Sandbox_Enum_SandboxReturnDisposition":{"type":["string"],"enum":["reworked","returned_to_inventory","return_to_merchant","dispose","donate"],"title":"Sandbox Return Disposition"},"ShipMonk_Warehouse_Returns_Sandbox_Enum_SandboxReturnsCompletionMode":{"type":["string"],"enum":["fully_received","short_received","excess_received","partially_received"],"title":"Sandbox Returns Completion Mode"},"ShipMonk_Warehouse_WarehouseReceiving_Enum_WarehouseReceivingPacking":{"type":["string"],"enum":["small_boxes","single_sku_pallet","mixed_sku_pallet","container_20_palletized","container_20_non_palletized","container_40_palletized","container_40_non_palletized","container_53_palletized","container_53_non_palletized","unknown"],"title":"Warehouse Receiving Packing"},"ShipMonk_WmsConnector_Order_ValueObject_WmsType":{"type":["string"],"enum":["shipmonk","deposco","merchant_facility"],"title":"Wms Type"}},"securitySchemes":{"api_key_header_Api-Key":{"type":"apiKey","in":"header","name":"Api-Key"}}},"x-errorIdentifiers":{"Fulfillment\\IntegrationsBundle\\ACCI\\Exception\\CannotCreateIntegrationForShipMonkAccountException":"d604c989-0673-4875-9472-e9e9784cd69c","Fulfillment\\IntegrationsBundle\\ACCI\\Exception\\CannotMoveStoreToDifferentAccountException":"4bf2ab5f-966f-43dc-b705-071bf721b15c","Fulfillment\\IntegrationsBundle\\ACCI\\Exception\\IntegrationAlreadyExistsException":"277e0c60-34cc-4ec4-86fd-74b0b8ea01c8","Fulfillment\\IntegrationsBundle\\ACCI\\Exception\\StoreNotAssignedToAnyAccountException":"4e54f15f-543f-49e5-a091-afda78be53e0","Fulfillment\\OrderBundle\\Exception\\PackageCannotBeSortedDuplicatePackageException":"d6613660-26bf-4cc0-adbc-b5b62d9294b5","Fulfillment\\OrderBundle\\Exception\\PackageCannotBeSortedException":"94cca74c-4fe7-4ac9-8b87-5bb1bcc3a6df","Fulfillment\\OrderBundle\\Exception\\PackageWasMissortedException":"f86a4393-726c-4e78-9a6c-6396e83bb54f","Fulfillment\\OrderBundle\\Exception\\PickedQuantityTooHighException":"bddba845-196d-4fd8-a264-7064b4a62657","Fulfillment\\UserBundle\\Exception\\AccountTradingPartnerNotFoundException":"da584e83-359f-4aab-9bbe-91fd4e9a18e7","Fulfillment\\WarehouseAppApiBundle\\Exception\\SingleUnitPickingJobPackingNeededException":"9c26f46d-96e6-42bc-83a5-53cc05ba3aaf","Fulfillment\\WarehouseBundle\\Exception\\CannotReleaseNonEmptyPickingToteException":"4336c2f6-8b8e-4574-b438-95e4de788d91","Fulfillment\\WarehouseBundle\\Exception\\MissingParentLocationException":"59ffbe5e-3149-4790-9c15-04648be75e5c","Fulfillment\\WarehouseBundle\\Exception\\TemporaryContainerNeedsToBeRestoredException":"0c7d3330-e398-4c8d-ac4f-79b0e30cdd55","ShipMonk\\SpecialProject\\Assembly\\Exception\\AssemblyIdentifierConflictException":"a32a7b03-2754-49a3-8e88-30e44615cf15","ShipMonk\\SpecialProject\\Exception\\SpecialProjectNumberConflictException":"b7c4e291-6f8d-4a5b-9e03-1d2f8a7c3b6e","ShipMonk\\UserManagement\\User\\Exception\\UserHasToHaveWarehouseException":"914df6a8-807c-4e15-b658-a3f52d911611","ShipMonk\\Warehouse\\PackageSorting\\Exception\\PackageAlreadySortedToGaylordException":"cdb6992d-ec66-4279-843b-0ca21e8e0497","ShipMonk\\Warehouse\\PackageSorting\\Exception\\PackageSortingGaylordNotFoundException":"0a71ce90-2010-417b-89a3-5b3f671a7e5b","ShipMonk\\Warehouse\\WarehouseReceiving\\Exception\\ConeIsRequiredForReceivingException":"7f56a600-3d3a-46be-86c7-b73cf23d6ce1","ShipMonk\\Warehouse\\WarehouseReceiving\\Exception\\DifferentLotControlExpectedForReceivingException":"018e9fb7-b7f3-77be-90e0-9a13164f87ba","ShipMonk\\Warehouse\\WarehouseReceiving\\Exception\\MixedLpnReceivingRequiredException":"9639190d-21f6-4497-b785-444a1ad47027"},"tags":[{"name":"Webhooks","description":"ShipMonk supports webhooks to help you stay updated in real time as key events happen in our system. Currently, we provide webhooks for the following areas:\n- Orders\n- Returns\n- Receivings\n\n## Webhooks Setup\nYou have full flexibility in configuring which webhooks to subscribe to. You can:\n- Use a single URL to receive all events, or\n- Define separate endpoints for individual webhook types.\n\nWebhook setup can be done by your ShipMonk support team.\n\n## Security\nAll webhooks support HTTP Basic Authentication. If you provide a username and password, ShipMonk will include these credentials in the webhook request. This allows you to restrict access and ensure only ShipMonk can call your endpoints.\n\n## Data Integrity\nEach webhook request sent by ShipMonk includes an `X-Sm-Signature` header. This header allows you to verify that the request genuinely originated from ShipMonk and was not tampered with.\n\nTo enable this verification, you must provide ShipMonk with a secret key (a random string of your choice). For every webhook, ShipMonk uses this secret key to generate a HMAC using the SHA-512 algorithm (HMAC-SHA512), applied to the raw payload. The resulting signature is included in the `X-Sm-Signature` header.\n\nTo validate the authenticity of a webhook:\n- Retrieve the raw payload from the HTTP POST request.\n- Using the same secret key and the HMAC-SHA512 algorithm, generate a signature from the payload.\n- Compare your generated signature to the value in the X-Sm-Signature header.\n- If they match, you can safely trust the request.\n\nThis mechanism ensures both the integrity and authenticity of the webhook payload.\n\n## Accepting the webhook\n\nWebhook requests are sent as HTTP POST requests. To acknowledge successful processing, your endpoint must respond with an HTTP status code in the 2xx range.\n- If a 2xx response is returned, the webhook is considered successfully delivered.\n- For any other response, ShipMonk will retry the webhook delivery up to 25 times, with a 5-minute delay between attempts."},{"name":"Receivings","description":"## ASN & Receiving Key\n- Each Receiving has an ASN and is uniquely identified by it.\n- Each Receiving can additionally have its own receiving_key and also be uniquely identified by it."},{"name":"Returns","description":""},{"name":"Orders","description":""},{"name":"Products","description":""},{"name":"Warehouses","description":""}],"servers":[{"url":"https://api.shipmonk.com","description":"Once you finish testing on Sandbox, our support team generates you Production API keys and store_id for production. Just write us at api@shipmonk.com and we will handle it."},{"url":"https://sandbox.shipmonk.dev","description":"Sandbox environment is used for preproduction testing. It allows you to play around without worries of corrupting the data. We highly recommend using the Sandbox environment and run tests before going to Production. To get access to the Sandbox, please contact the ShipMonk support team. Note: Sandbox access can only be requested by customers with signed contracts."}],"webhooks":{"orderShipmentNotification":{"post":{"operationId":"webhook-order-shipment-notification","summary":"Shipment Notification","tags":["Webhooks"],"description":"Once the order is fulfilled, ShipMonk can notify the 3rd party software of such event via webhook or Marketplace via direct integration. The payload consists of tracking and packing information.\n\nTriggers for sending notification are:\n- once regular order is packed\n- batch is completed\n- wholesale order is picked up\n\nNotification is sent with delay which can be set per each store in ShipMonk OMS.\n\nYour endpoint URL can be set up in the store detail in ShipMonk OMS. Please note that Basic Auth (username and password) is supported only.\n\nWe expect the status code 200 in response. When we receive another status call, we will be re-trying it for the next 3 days.\n\nTo test it, place the order and submit it for fulfilment. You have to make sure the inventory is available and order is all right first (it has set the shipping service and the address is valid). In production the order is shipped by our warehouse employees, while for testing you will have to call our `complete-order` endpoint.\n\nEdge cases:\n- If the order is big and cannot fit into a single packaging, we will send out multiple packages. Each package has its own tracking number inside of packages array.\n- If the inventory of any SKU is not available, it is possible to manually split the order in the ShipMonk app and then we send Shipment Notification per each shipment.\n- If the order is split and send out within multiple days, we send the Shipment Notification just once (when the first package is sent out)\n\n`fulfilled_quantity` vs `ordered_quantity`: The value of these two fields might differ in case of partially fulfilled Orders. If a Product consists of `1x Item A` and `1x Item B`, when the customer orders 2 Products and the Shipment contains 1 piece of Item A and 2 pieces of Item B, then `ordered_quantity = 2` but `fulfilled_quantity = 1`.\n\nThe list of carriers as we return them via webhook as `carrier`:\n\n\n| #  | Carrier         |\n|----|-----------------|\n| 1 | CanadaPost       |\n| 2 | Cirro            |\n| 3 | DHL eCommerce    |\n| 4 | DHL Express      |\n| 5 | DPD              |\n| 6 | ePost            |\n| 7 | FedEx            |\n| 8 | Global-E        |\n| 9 | OnTrac          |\n| 10 | Passport        |\n| 11 | Royal Mail      |\n| 12 | ShipMonk        |\n| 13 | SpeedX          |\n| 14 | UPS             |\n| 15 | USPS            |\n\nThe above carriers cover standard shipments. In cases involving custom labels or freight shipments, the `carrier` field may contain values outside of this list.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipMonk_OMS_Notification_ApiResource_ShipmentNotificationOutput"}}}},"responses":{"200":{"description":"Return a 2xx status to indicate that the data was received successfully"},"default":{"description":"For a 4xx status, ShipMonk will retry the webhook delivery for the next 3 days."}}}},"orderStatusChange":{"post":{"operationId":"webhook-order-status-change","summary":"Order status change","tags":["Webhooks"],"description":"As an order progresses from initial import to full fulfillment, it transitions through multiple statuses. ShipMonk can notify external systems of these status changes via webhooks.\n\n## Supported Order Webhooks\nCurrently ShipMonk supports these order-related webhooks.\n\n- Order being back-ordered (`processing_status`: `back-order`)\n- Order is unable to submit (`processing_status`: `unable_to_submit`)\n- Order is queued to submit (`processing_status`: `queued_to_submit`)\n- Order is subscription - Order (`processing_status`: `subscription`)\n- Order is package-forwarding - Order (`processing_status`: `package_forwarding`)\n- Order is put to on hold (`processing_status`: `on_hold`)\n- Order is submitted (`processing_status`: `submitted`)\n- Order is being picked (`processing_status`: `pick_in_progress`)\n- Order is being packed (`processing_status`: `pack_in_progress`)\n- Order is packed (`processing_status`: `packed`)\n- Order is awaiting pickup (`processing_status`: `awaiting_pick_up`)\n- Order is awaiting carrier processing (`processing_status`: `awaiting_carrier_processing`)\n- Order is en route (`processing_status`: `en_route`)\n- Order is delivered (`processing_status`: `delivered`)\n- Order is undeliverable (`processing_status`: `undeliverable`)\n- Order is shipped, but it’s untrackable (`processing_status`: `shipped_untrackable`)\n- Order cancellation requested (`processing_status`: `cancellation_requested`)\n- Order is cancelled (`processing_status`: `cancelled`)\n\nAll order-related webhooks are closely tied to the order’s processing-status. Each webhook is triggered by a change in the processing-status, reflecting key moments in the order lifecycle.\n\n## Payload Structure (JSON Schema)\nAll order-related webhooks share the same JSON schema, which matches the response of our GET endpoint for retrieving a single order.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderDetailOutput"}}}},"responses":{"200":{"description":"Return a 2xx status to indicate that the data was received successfully"},"default":{"description":"For a 4xx status, ShipMonk will retry the webhook delivery up to 100 times, with a 5-minute delay between attempts."}}}},"returnStatusChange":{"post":{"operationId":"webhook-return-status-change","summary":"Return status change","tags":["Webhooks"],"description":"## Supported Return Webhooks\nAll return-related webhooks are closely tied to the status of the return. Each webhook is triggered by a specific status transition, marking important stages in the return process.\n\n- Return created (`status`: `status_created`)\n- Return in progress (`status`: `in_progress`)\n- Return en route (`status`: `en_route`)\n- Return returned (`status`: `returned`)\n\n## Payload Structure (JSON Schema)\nThe payload of each return-related webhook matches the structure of a single return object as returned by the `GET /v1/integrations/returns-list` endpoint. While the `GET /v1/integrations/returns-list` endpoint responds with an array of return objects (`returns-list` field), each webhook delivers the full data of one return in the same format. This allows for easy reuse of the return model across both API responses and webhook events.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fulfillment_IntegrationsBundle_ApiResource_ReturnOutput"}}}},"responses":{"200":{"description":"Return a 2xx status to indicate that the data was received successfully"},"default":{"description":"For a 4xx status, ShipMonk will retry the webhook delivery up to 100 times, with a 5-minute delay between attempts."}}}},"receivingStatusChange":{"post":{"operationId":"webhook-receiving-status-change","summary":"Receiving status change","tags":["Webhooks"],"description":"## Supported Receiving Webhooks\nAll receiving-related webhooks are closely tied to the status of the receiving. Each webhook is triggered when the receiving transitions to a specific `status`, reflecting key milestones in the receiving process.\n\n- Receiving awaiting (`status`: `awaiting`)\n- Receiving in progress (`status`: `in_progress`)\n- Receiving arrived (`status`: `arrived`)\n- Receiving received (`status`: `received`)","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipMonk_OMS_Receiving_ApiResource_PublicApiReceivingOutput"}}}},"responses":{"200":{"description":"Return a 2xx status to indicate that the data was received successfully"},"default":{"description":"For a 4xx status, ShipMonk will retry the webhook delivery up to 100 times, with a 5-minute delay between attempts."}}}}}}