--- swagger: "2.0" info: description: "Please use the API manual" version: "v2" title: "Tradecloud SAP SOAP Connector API" termsOfService: "https://www.tradecloud1.com/en/terms-and-conditions" contact: name: "Tradecloud API support" url: "https://tradecloud.gitbook.io/api/support" email: "support@tradecloud1.com" license: name: "Proprietary" url: "https://www.tradecloud1.com/en/terms-and-conditions" schemes: - "https" paths: /sap-soap-connector/company/{companyId}/order/{purchaseOrderNumber}/fetch: get: tags: - "sap-soap-connector" summary: "Trigger purchase order fetch flow" description: "Queue a request to fetch a purchase order from SAP" operationId: "requestPurchaseOrderFetch" produces: - "application/json" parameters: - in: "path" name: "companyId" required: true description: "The companyId for which the purchase order will be fetched" type: string - in: "path" name: "purchaseOrderNumber" required: true description: "The purchase order number to be fetched" type: string responses: 200: description: "Successfully triggered purchase order fetch flow" 400: $ref: "#/responses/badRequest" 401: $ref: "#/responses/unauthorized" 403: $ref: "#/responses/forbidden" 404: $ref: "#/responses/notFound" 500: $ref: "#/responses/internalServerError" 502: $ref: "#/responses/badGateway" 503: $ref: "#/responses/serviceUnavailable" 504: $ref: "#/responses/gatewayTimeout" security: - accessToken: [] - basicAuth: [] securityDefinitions: accessToken: description: "Use the access token to authenticate." type: "apiKey" name: "Authorization" in: "header" basicAuth: description: "Use basic authentication to authenticate." type: "basic" responses: badRequest: description: "Bad request, the user should check the response body for more info." unauthorized: description: "Not authenticated, the user should authenticate using a valid access token, use Basic Authentication, or refresh to get a valid token." forbidden: description: "Not authorized, the user is authenticated but does not have the necessary permission." notFound: description: "The requested resource could not be found." internalServerError: description: "An unexpected error occurred, Tradecloud ops will be alerted." badGateway: description: "Service is not healthy (bad gateway), Tradecloud ops will be alerted." serviceUnavailable: description: "Service is unavailable (overloaded or down for maintenance), Tradecloud ops will be alerted." gatewayTimeout: description: "Service is unavailable (gateway timeout), Tradecloud ops will be alerted."