--- updatedAt: 2026-09-03T18:03:01.000Z agentTools: projectIndex: https://developers.apicbase.com/llms.txt --- # Edit Supplier Ordering Details Edits the supplier's ordering details for one or more outlets. Details not included in the payload keep their current values. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "apicbase", "version": "2" }, "servers": [ { "url": "https://api.apicbase.com/api/v2/" } ], "security": [ { "sec0": [] } ], "paths": { "/suppliers/{supplier_id}/ordering-details/": { "post": { "summary": "Edit Supplier Ordering Details", "description": "Bulk updates ordering configuration for multiple outlets linked to the supplier. Updates delivery schedules, minimum order amounts, delivery fees, customer numbers, and email addresses.", "operationId": "edit-supplier-ordering-details", "parameters": [ { "name": "supplier_id", "in": "path", "description": "A supplier ID.", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "outlet" ], "properties": { "outlet": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Outlet ID to update" } } }, "delivery_schedule": { "type": "array", "description": "Delivery day configurations. Cannot be provided if all_delivery_days is true", "items": { "type": "object", "required": [ "delivery_day" ], "properties": { "delivery_day": { "type": "integer", "minimum": 1, "maximum": 7, "description": "Day of week (1=Monday, 7=Sunday)" }, "active": { "type": "boolean", "description": "Whether day is active" }, "lockup_day": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 7, "description": "Order lockup day (1=Monday, 7=Sunday)" }, "lockup_time": { "type": "string", "nullable": true, "pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$", "description": "Order lockup time (HH:MM format, defaults to 23:59 if lockup_day is set)" }, "send_reminder": { "type": "boolean", "description": "Send reminder (requires lockup_day AND lockup_time)" } } } }, "minimum_order_amount": { "type": "string", "nullable": true, "pattern": "^[0-9]+\\.?[0-9]*$", "description": "Minimum order amount" }, "standard_delivery_fee": { "type": "string", "nullable": true, "pattern": "^[0-9]+\\.?[0-9]*$", "description": "Delivery fee" }, "customer_numbers": { "type": "array", "items": { "type": "string" }, "description": "Customer reference numbers (replaces existing)" }, "supplier_email_addresses": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "Email addresses for orders" }, "assortment_sync_id": { "type": "string", "nullable": true, "description": "Sync ID (only for integrated suppliers with assortment support, not for order-only integrated suppliers)" } } } }, "examples": { "Request": { "value": [ { "outlet": { "id": "123" }, "delivery_schedule": [ { "delivery_day": 1, "active": true, "lockup_day": 7, "lockup_time": "18:00", "send_reminder": true }, { "delivery_day": 3, "active": false, "lockup_day": null, "lockup_time": null, "send_reminder": false } ], "minimum_order_amount": "500.00", "standard_delivery_fee": "25.50", "customer_numbers": [ "CUST-001", "CUST-002" ], "supplier_email_addresses": [ "orders@supplier.com" ], "assortment_sync_id": "SYNC-12345" } ] } } } } }, "responses": { "200": { "description": "Success - Returns the updated outlet-supplier connectors", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "type": "object", "properties": { "outlet": { "type": "object", "required": [ "id", "name", "url" ], "properties": { "id": { "type": "string", "example": "123" }, "name": { "type": "string", "example": "Downtown Location" }, "url": { "type": "string", "example": "http://api.example.com/api/v2/accounts/outlets/123/" } } }, "all_delivery_days": { "type": "boolean", "description": "Whether supplier delivers all days of the week" }, "delivery_schedule": { "type": "array", "description": "List of delivery day configurations (empty if all_delivery_days is true)", "items": { "type": "object", "properties": { "delivery_day": { "type": "integer", "minimum": 1, "maximum": 7, "description": "Day of week (1=Monday, 7=Sunday)" }, "active": { "type": "boolean", "description": "Whether this delivery day is active" }, "lockup_day": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 7, "description": "Day when orders lock for this delivery (1=Monday, 7=Sunday)" }, "lockup_time": { "type": "string", "nullable": true, "pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$", "description": "Time when orders lock (HH:MM format)" }, "send_reminder": { "type": "boolean", "description": "Whether to send reminder (requires lockup_day and lockup_time)" } } } }, "minimum_order_amount": { "type": "string", "nullable": true, "pattern": "^[0-9]+\\.?[0-9]*$", "description": "Minimum order value required" }, "standard_delivery_fee": { "type": "string", "nullable": true, "pattern": "^[0-9]+\\.?[0-9]*$", "description": "Standard delivery fee (shows fallback from supplier if null)" }, "customer_numbers": { "type": "array", "items": { "type": "string" }, "description": "Customer reference numbers for this outlet" }, "supplier_email_addresses": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "Email addresses for order communications" }, "assortment_sync_id": { "type": "string", "nullable": true, "description": "Assortment synchronization ID (only for integrated suppliers with assortment support)" } } } } } } } } }, "400": { "description": "Bad Request - Validation errors", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "OutletsNotFound": { "value": { "error": "One or more outlets not found in your library" } }, "OutletsNotLinked": { "value": { "error": "Outlets [123, 456] are not linked to the supplier" } }, "DuplicateWeekdays": { "value": { "error": "Duplicate weekdays are not allowed" } }, "ScheduleWithAllDays": { "value": { "error": "Schedule cannot be provided when all_delivery_days is True" } }, "ReminderRequiresLockup": { "value": { "error": "Reminder can only be true if lockup_day and lockup_time are set" } }, "RequiredDeliveryDay": { "value": { "error": "Outlet 123: At least one active delivery day is required" } } } } } }, "403": { "description": "Forbidden - User lacks manage_procurement permission" }, "404": { "description": "Not Found - Supplier does not exist" } }, "deprecated": false, "x-readme": { "code-samples": [], "explorer-enabled": true } } } }, "components": { "securitySchemes": { "sec0": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "https://app.apicbase.com/oauth/authorize/", "tokenUrl": "https://api.apicbase.com/oauth/token/", "refreshUrl": "https://api.apicbase.com/oauth/token/", "scopes": { "accounts": "Access to user, library, and outlet endpoints.", "library": "Access to library content (recipes, ingredients, menus, packages).", "inventory": "Access to inventory events and stock data.", "procurement": "Access to purchase orders, deliveries, and supplier ordering.", "sales": "Access to POS, sales, and sales analytics endpoints.", "media": "Access to media (images, files)." } } } } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```