{"openapi":"3.1.0","info":{"title":"AMAGU MARKET — API для клиентов","description":"Карточки, остатки и приём заказов партнёров. При 429/503 соблюдайте Retry-After.","version":"1.3.0"},"paths":{"/v1/products":{"get":{"tags":["Client export API v1"],"summary":"Карточки активных товаров с ценой продажи","operationId":"products_v1_products_get","parameters":[{"name":"after_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"description":"Курсор next_cursor из предыдущего ответа","title":"After Id"},"description":"Курсор next_cursor из предыдущего ответа"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":100,"title":"Limit"}},{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":6500},{"type":"null"}],"description":"До 100 UUID МойСклад или resanta:ID_ПОСТАВЩИКА через запятую","title":"Ids"},"description":"До 100 UUID МойСклад или resanta:ID_ПОСТАВЩИКА через запятую"},{"name":"sku","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":80},{"type":"null"}],"title":"Sku"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportProductsPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Ключ отсутствует или недействителен"},"403":{"description":"Эндпоинт закрыт или нет разрешения"},"429":{"description":"Лимит запросов; см. Retry-After"},"503":{"description":"API временно недоступен; см. Retry-After"}},"security":[{},{"ApiKey":[]},{"BearerAuth":[]}]}},"/v1/stocks":{"get":{"tags":["Client export API v1"],"summary":"Остатки активных товаров, включая нулевые","operationId":"stocks_v1_stocks_get","parameters":[{"name":"after_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"description":"Курсор next_cursor из предыдущего ответа","title":"After Id"},"description":"Курсор next_cursor из предыдущего ответа"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":100,"title":"Limit"}},{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":6500},{"type":"null"}],"description":"До 100 UUID МойСклад или resanta:ID_ПОСТАВЩИКА через запятую","title":"Ids"},"description":"До 100 UUID МойСклад или resanta:ID_ПОСТАВЩИКА через запятую"},{"name":"sku","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":80},{"type":"null"}],"title":"Sku"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportStocksPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Ключ отсутствует или недействителен"},"403":{"description":"Эндпоинт закрыт или нет разрешения"},"429":{"description":"Лимит запросов; см. Retry-After"},"503":{"description":"API временно недоступен; см. Retry-After"}},"security":[{},{"ApiKey":[]},{"BearerAuth":[]}]}},"/v1/orders":{"post":{"tags":["Partner orders v1"],"summary":"Принять продажи и немедленно зарезервировать товар","operationId":"receive_v1_orders_post","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerSalesIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerReceipt"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Требуется действующий ключ"},"403":{"description":"Нет доступа к заказам этого клиента"},"409":{"description":"Конфликт или недостаточно товара; пакет не принят"},"429":{"description":"Соблюдайте Retry-After"},"503":{"description":"Повторите с тем же Idempotency-Key"}},"security":[{"ApiKey":[]},{"BearerAuth":[]}]},"get":{"tags":["Partner orders v1"],"summary":"Расчётные периоды и общие заказы текущего партнёра","operationId":"periods_v1_orders_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":100000,"minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PartnerPeriodRead"},"title":"Response Periods V1 Orders Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Требуется действующий ключ"},"403":{"description":"Нет доступа к заказам этого клиента"},"409":{"description":"Конфликт или недостаточно товара; пакет не принят"},"429":{"description":"Соблюдайте Retry-After"},"503":{"description":"Повторите с тем же Idempotency-Key"}},"security":[{"ApiKey":[]},{"BearerAuth":[]}]}},"/v1/orders/cancellations":{"post":{"tags":["Partner orders v1"],"summary":"Отменить неотправленные позиции и освободить резерв","operationId":"cancel_v1_orders_cancellations_post","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCancelIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerReceipt"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Требуется действующий ключ"},"403":{"description":"Нет доступа к заказам этого клиента"},"409":{"description":"Конфликт или недостаточно товара; пакет не принят"},"429":{"description":"Соблюдайте Retry-After"},"503":{"description":"Повторите с тем же Idempotency-Key"}},"security":[{"ApiKey":[]},{"BearerAuth":[]}]}},"/v1/orders/shipments":{"post":{"tags":["Partner orders v1"],"summary":"Зафиксировать отправку внешней позиции; последующая отмена запрещена","operationId":"ship_v1_orders_shipments_post","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCancelIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerReceipt"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Требуется действующий ключ"},"403":{"description":"Нет доступа к заказам этого клиента"},"409":{"description":"Конфликт или недостаточно товара; пакет не принят"},"429":{"description":"Соблюдайте Retry-After"},"503":{"description":"Повторите с тем же Idempotency-Key"}},"security":[{"ApiKey":[]},{"BearerAuth":[]}]}},"/v1/orders/{period_id}":{"get":{"tags":["Partner orders v1"],"summary":"Детализация общего заказа: продажи текущего партнёра","operationId":"detail_v1_orders__period_id__get","parameters":[{"name":"period_id","in":"path","required":true,"schema":{"type":"string","title":"Period Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":100000,"minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Требуется действующий ключ"},"403":{"description":"Нет доступа к заказам этого клиента"},"409":{"description":"Конфликт или недостаточно товара; пакет не принят"},"429":{"description":"Соблюдайте Retry-After"},"503":{"description":"Повторите с тем же Idempotency-Key"}},"security":[{"ApiKey":[]},{"BearerAuth":[]}]}}},"components":{"schemas":{"ExportAttribute":{"properties":{"slug":{"type":"string","title":"Slug"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"data_type":{"type":"string","title":"Data Type"}},"type":"object","required":["slug","name","value","data_type"],"title":"ExportAttribute"},"ExportCategory":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"slug":{"type":"string","title":"Slug"},"parent_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Parent Id"}},"type":"object","required":["id","name","slug","parent_id"],"title":"ExportCategory"},"ExportImage":{"properties":{"url":{"type":"string","title":"Url"},"sort_order":{"type":"integer","title":"Sort Order"},"is_primary":{"type":"boolean","title":"Is Primary"}},"type":"object","required":["url","sort_order","is_primary"],"title":"ExportImage"},"ExportProduct":{"properties":{"id":{"type":"string","title":"Id","description":"UUID МойСклад либо resanta:ID_ПОСТАВЩИКА; общий ключ карточки и остатка"},"source":{"type":"string","enum":["moysklad","resanta"],"title":"Source"},"moysklad_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Moysklad Id"},"supplier_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Supplier Id"},"minimum_order_quantity":{"type":"integer","minimum":1.0,"title":"Minimum Order Quantity","description":"Количество в упаковке: минимум и кратность заказа. Если доступный остаток меньше упаковки, его можно заказать поштучно."},"sku":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sku"},"barcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Barcode"},"name":{"type":"string","title":"Name"},"slug":{"type":"string","title":"Slug"},"url":{"type":"string","title":"Url"},"short_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Short Description"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"price":{"type":"string","title":"Price"},"compare_at_price":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Compare At Price"},"currency":{"type":"string","const":"RUB","title":"Currency","default":"RUB"},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Url"},"images":{"items":{"$ref":"#/components/schemas/ExportImage"},"type":"array","title":"Images"},"categories":{"items":{"$ref":"#/components/schemas/ExportCategory"},"type":"array","title":"Categories"},"tags":{"items":{"$ref":"#/components/schemas/ExportTag"},"type":"array","title":"Tags"},"attributes":{"items":{"$ref":"#/components/schemas/ExportAttribute"},"type":"array","title":"Attributes"},"variant":{"anyOf":[{"$ref":"#/components/schemas/ExportVariant"},{"type":"null"}]},"weight":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Weight"},"dimensions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dimensions"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"video_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Video Url"},"meta_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Meta Title"},"meta_keywords":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Meta Keywords"},"meta_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Meta Description"},"average_rating":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Average Rating"},"review_count":{"type":"integer","title":"Review Count"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","source","moysklad_id","supplier_id","minimum_order_quantity","sku","barcode","name","slug","url","short_description","description","price","compare_at_price","image_url","images","categories","tags","attributes","variant","weight","dimensions","unit","video_url","meta_title","meta_keywords","meta_description","average_rating","review_count","created_at"],"title":"ExportProduct"},"ExportProductsPage":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ExportProduct"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"has_more":{"type":"boolean","title":"Has More"},"generated_at":{"type":"string","format":"date-time","title":"Generated At"}},"type":"object","required":["items","next_cursor","has_more","generated_at"],"title":"ExportProductsPage"},"ExportStock":{"properties":{"id":{"type":"string","title":"Id","description":"UUID МойСклад либо resanta:ID_ПОСТАВЩИКА; общий ключ карточки и остатка"},"source":{"type":"string","enum":["moysklad","resanta"],"title":"Source"},"moysklad_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Moysklad Id"},"supplier_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Supplier Id"},"sku":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sku"},"stock_quantity":{"type":"integer","title":"Stock Quantity"},"in_stock":{"type":"boolean","title":"In Stock"}},"type":"object","required":["id","source","moysklad_id","supplier_id","sku","stock_quantity","in_stock"],"title":"ExportStock"},"ExportStocksPage":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ExportStock"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"has_more":{"type":"boolean","title":"Has More"},"generated_at":{"type":"string","format":"date-time","title":"Generated At"}},"type":"object","required":["items","next_cursor","has_more","generated_at"],"title":"ExportStocksPage"},"ExportTag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"slug":{"type":"string","title":"Slug"}},"type":"object","required":["id","name","slug"],"title":"ExportTag"},"ExportVariant":{"properties":{"group_id":{"type":"integer","title":"Group Id"},"label":{"type":"string","title":"Label"},"attribute_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Attribute Label"}},"type":"object","required":["group_id","label","attribute_label"],"title":"ExportVariant"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"PartnerCancelIn":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PartnerCancellation"},"type":"array","maxItems":100,"minItems":1,"title":"Items"}},"additionalProperties":false,"type":"object","required":["items"],"title":"PartnerCancelIn"},"PartnerCancellation":{"properties":{"marketplace":{"type":"string","maxLength":64,"minLength":1,"pattern":"^[a-z0-9][a-z0-9_.-]*$","title":"Marketplace"},"external_order_id":{"type":"string","maxLength":120,"minLength":1,"title":"External Order Id"},"external_line_id":{"type":"string","maxLength":120,"minLength":1,"title":"External Line Id"}},"additionalProperties":false,"type":"object","required":["marketplace","external_order_id","external_line_id"],"title":"PartnerCancellation"},"PartnerPeriodRead":{"properties":{"id":{"type":"string","title":"Id"},"starts_at":{"type":"string","format":"date-time","title":"Starts At"},"ends_at":{"type":"string","format":"date-time","title":"Ends At"},"closed":{"type":"boolean","title":"Closed"},"order_number":{"type":"string","title":"Order Number"},"marketplace":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Marketplace"},"total_quantity":{"type":"integer","title":"Total Quantity"},"total_amount":{"type":"string","title":"Total Amount"},"currency":{"type":"string","const":"RUB","title":"Currency","default":"RUB"},"pending_corrections":{"type":"integer","title":"Pending Corrections","default":0},"sync_status":{"type":"string","enum":["pending","synced","error"],"title":"Sync Status"}},"additionalProperties":false,"type":"object","required":["id","starts_at","ends_at","closed","order_number","marketplace","total_quantity","total_amount","sync_status"],"title":"PartnerPeriodRead"},"PartnerReceipt":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PartnerSaleResult"},"type":"array","title":"Items"},"replayed":{"type":"boolean","title":"Replayed","default":false},"stock_reservation":{"type":"string","enum":["committed","released","unchanged"],"title":"Stock Reservation","default":"committed"},"moysklad":{"type":"string","enum":["queued","unchanged"],"title":"Moysklad","default":"queued"}},"additionalProperties":false,"type":"object","required":["items"],"title":"PartnerReceipt"},"PartnerSaleIn":{"properties":{"marketplace":{"type":"string","maxLength":64,"minLength":1,"pattern":"^[a-z0-9][a-z0-9_.-]*$","title":"Marketplace"},"external_order_id":{"type":"string","maxLength":120,"minLength":1,"title":"External Order Id"},"external_line_id":{"type":"string","maxLength":120,"minLength":1,"title":"External Line Id"},"product_id":{"type":"string","maxLength":64,"minLength":1,"title":"Product Id","description":"id из /v1/products: UUID МойСклад"},"quantity":{"type":"integer","maximum":100000.0,"minimum":1.0,"title":"Quantity"}},"additionalProperties":false,"type":"object","required":["marketplace","external_order_id","external_line_id","product_id","quantity"],"title":"PartnerSaleIn"},"PartnerSaleResult":{"properties":{"sale_id":{"type":"string","title":"Sale Id"},"period_id":{"type":"string","title":"Period Id"},"marketplace":{"type":"string","title":"Marketplace"},"external_order_id":{"type":"string","title":"External Order Id"},"external_line_id":{"type":"string","title":"External Line Id"},"product_id":{"type":"string","title":"Product Id"},"quantity":{"type":"integer","title":"Quantity"},"cancelled_quantity":{"type":"integer","title":"Cancelled Quantity"},"unit_price":{"type":"string","title":"Unit Price"},"status":{"type":"string","enum":["reserved","duplicate","cancelled","shipped","requires_review"],"title":"Status"}},"additionalProperties":false,"type":"object","required":["sale_id","period_id","marketplace","external_order_id","external_line_id","product_id","quantity","cancelled_quantity","unit_price","status"],"title":"PartnerSaleResult"},"PartnerSalesIn":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PartnerSaleIn"},"type":"array","maxItems":100,"minItems":1,"title":"Items"}},"additionalProperties":false,"type":"object","required":["items"],"title":"PartnerSalesIn"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"X-API-Key"},"BearerAuth":{"type":"http","scheme":"bearer"}}},"x-current-policy":{"global_requests_per_minute":600,"products":{"mode":"api_key","requests_per_minute":30,"max_page_size":100},"stocks":{"mode":"api_key","requests_per_minute":60,"max_page_size":100},"orders":{"mode":"api_key","requests_per_minute":30,"max_batch_size":100}},"servers":[{"url":"https://amagu-market.ru/api"}]}