Actions65
- Order Actions
- Product Actions
- Store Shipping Account Actions
- Delivery Companies API Actions
- Team User Actions
- Store Actions
- State Actions
- Stop Desk Actions
- City Or Municipality Actions
- Store Client Actions
- Store Coupon Actions
- Store Pro Stock Actions
Delivery Companies API → Ship All Store Confirmed Orders
AI-generatedSummary
Ship all confirmed orders of a store using a specified shipping account via the Delivery Companies API.
Inputs
- Store Shipping Account ID (required) — MongoDB ObjectId of the store's shipping account to be used for shipping all confirmed orders.
- Force Custom Auth Header — Option to use a custom API key from the node instead of configured credentials.
- Force Custom Base URL — Option to use a custom Base URL for API requests instead of the one in credentials.
- Custom Base URL — Custom Base URL to use if 'Force Custom Base URL' is enabled.
- Custom API Key — Custom API key to send if 'Force Custom Auth Header' is enabled.
- Request Options — Additional request configurations like batching, proxy, timeout, and SSL handling.
Output shape
A JSON response from the Delivery Companies API indicating the result of shipping all confirmed orders for the specified store shipping account.
The output shape depends on the API's response format. Request batching is supported and can be configured in Request Options. Errors or failures will be returned in the API response as per its specifications.
Examples
Example 1: Ship all confirmed orders for a store using the default credentials and base URL.
Provide the Store Shipping Account ID and keep force custom auth and base URL options disabled.
Example 2: Ship all confirmed orders using a custom API key and base URL.
Enable 'Force Custom Auth Header' and 'Force Custom Base URL', then provide the custom API key and base URL accordingly.