{
  "aid": "swaggerhub.alfah:ap-supplier-order-service-api-1.0",
  "name": "Supplier Order Service API",
  "type": "Index",
  "description": "The service goal is order and order information exchange between two systems using standard HTTP(s) technology and the REST approach.\n\nThe orders producer is ALFAH GmbH as the reseller company (Reseller).\nThe orders consumer is a supplier company (Supplier).\n\nWhen new order is produced by Reseller, the order becomes available for Supplier via the service.\nThe duty of Supplier is checking for new orders every period of time, for example each 1-10 minutes.\n\nSupplier may fetch order(s) using filter criteria like 'Status' or request the necessary order by the order id.\n\nThe Supplier as order consumer should update order status according to the actual order workflow which is managed and controlled by the Supplier side.\n\nThe order status updating by Supplier is translated by Reseller accordingly.\nThe service makes possible for Supplier to send shipment info related to the each order. The shipment information will be available for Reseller and its customers correspondingly. \n\nStandard Ordering workflow for Supplier\n\nPoll orders every short period of time -  1-10 minutes for catching new orders which are arrived\n\nHTTP GET Request\n\nhttps://ap-cloud-service-gateway-preprod.alfah.de/ap-supplier-order-service/orders?status-id=OUTSTANDING\n\nThe order status 'OUTSTANDING' - means orders which are not initiated yet by Supplier.\n\nAfter such 'OUTSTANDING' order(s) was read and added to a Supplier system, Supplier should change this order status to 'CONFIRMED', \nit makes a feedback for Reseller that the order is read by Supplier, checked and confirmed for further processing.\n\n'ExternalOrderId' is set by Supplier to make the consistent relation between Reseller and Supplier orders. \nIt can be valuable for issues investigations and for the invoicing step. \n\nIf something goes wrong with the order, for example 'out of stock' issue, 'invalid item number' issue and etc, the order status should be set to 'CANCELLED' by Supplier which indicates to Reseller and its customer that the order can not be fullfiled.\n\nThe order status is changed to 'SHIPPED' by Supplier when the order has been shipped to a customer.\n\nOn this step an order shipment info can be added to the order as well, which is helpful for customers.\nThis step is optional, but preferable.\n\nOrder status is changed to 'COMPLETED' by Supplier to indicate that order was delivered to the customer and the ordering phase is completed. The invoicing phase begins.\nThis step is optional, but preferable.\n\n\nThe order update/adjustment is done with HTTP PUT request which includes updated order info in its body.\n\nhttps://ap-cloud-service-gateway-preprod.alfah.de/ap-supplier-order-service/{order-id}\n\n'OrderId' is the only required field for the PUT request, so the Supplier side does not require to pass the prefilled Order schema.\n\nExample:\nPUT method with such order is still valid and does not affect on any fields (except 'ExternalOrderId') associated with the order.\n{\n  \"OrderId\": \"12345.1\",\n  \"ExternalOrderId\": \"54321\",\n}\n\n\nAuthentication is a token based. Token is set in each HTTP header as 'Authentication':'SECRET_TOKEN'.\n\nSECRET_TOKEN is considered as permanent but can be changed by Supplier or Reseller request (manual effort is needed).\n\nEnvironments: \n\nPreproduction  for testing: https://ap-cloud-service-gateway-preprod.alfah.de/ap-supplier-order-service\n\nProduction for ready to go systems: https://ap-cloud-service-gateway.alfah.de/ap-supplier-order-service\n",
  "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/swaggerhub.alfah/ap-supplier-order-service-api/1.0/apis.json",
  "tags": [
    "swaggerhub.alfah",
    "ap-supplier-order-service-api"
  ],
  "created": "2026-04-04",
  "modified": "2026-04-04",
  "specificationVersion": "0.19",
  "access": "3rd-Party",
  "maintainers": [
    {
      "FN": "Jentic",
      "X-github": "jentic",
      "url": "https://github.com/jentic"
    }
  ],
  "apis": [
    {
      "aid": "swaggerhub.alfah:ap-supplier-order-service-api-1.0",
      "name": "Supplier Order Service API",
      "description": "The service goal is order and order information exchange between two systems using standard HTTP(s) technology and the REST approach.\n\nThe orders producer is ALFAH GmbH as the reseller company (Reseller).\nThe orders consumer is a supplier company (Supplier).\n\nWhen new order is produced by Reseller, the order becomes available for Supplier via the service.\nThe duty of Supplier is checking for new orders every period of time, for example each 1-10 minutes.\n\nSupplier may fetch order(s) using filter criteria like 'Status' or request the necessary order by the order id.\n\nThe Supplier as order consumer should update order status according to the actual order workflow which is managed and controlled by the Supplier side.\n\nThe order status updating by Supplier is translated by Reseller accordingly.\nThe service makes possible for Supplier to send shipment info related to the each order. The shipment information will be available for Reseller and its customers correspondingly. \n\nStandard Ordering workflow for Supplier\n\nPoll orders every short period of time -  1-10 minutes for catching new orders which are arrived\n\nHTTP GET Request\n\nhttps://ap-cloud-service-gateway-preprod.alfah.de/ap-supplier-order-service/orders?status-id=OUTSTANDING\n\nThe order status 'OUTSTANDING' - means orders which are not initiated yet by Supplier.\n\nAfter such 'OUTSTANDING' order(s) was read and added to a Supplier system, Supplier should change this order status to 'CONFIRMED', \nit makes a feedback for Reseller that the order is read by Supplier, checked and confirmed for further processing.\n\n'ExternalOrderId' is set by Supplier to make the consistent relation between Reseller and Supplier orders. \nIt can be valuable for issues investigations and for the invoicing step. \n\nIf something goes wrong with the order, for example 'out of stock' issue, 'invalid item number' issue and etc, the order status should be set to 'CANCELLED' by Supplier which indicates to Reseller and its customer that the order can not be fullfiled.\n\nThe order status is changed to 'SHIPPED' by Supplier when the order has been shipped to a customer.\n\nOn this step an order shipment info can be added to the order as well, which is helpful for customers.\nThis step is optional, but preferable.\n\nOrder status is changed to 'COMPLETED' by Supplier to indicate that order was delivered to the customer and the ordering phase is completed. The invoicing phase begins.\nThis step is optional, but preferable.\n\n\nThe order update/adjustment is done with HTTP PUT request which includes updated order info in its body.\n\nhttps://ap-cloud-service-gateway-preprod.alfah.de/ap-supplier-order-service/{order-id}\n\n'OrderId' is the only required field for the PUT request, so the Supplier side does not require to pass the prefilled Order schema.\n\nExample:\nPUT method with such order is still valid and does not affect on any fields (except 'ExternalOrderId') associated with the order.\n{\n  \"OrderId\": \"12345.1\",\n  \"ExternalOrderId\": \"54321\",\n}\n\n\nAuthentication is a token based. Token is set in each HTTP header as 'Authentication':'SECRET_TOKEN'.\n\nSECRET_TOKEN is considered as permanent but can be changed by Supplier or Reseller request (manual effort is needed).\n\nEnvironments: \n\nPreproduction  for testing: https://ap-cloud-service-gateway-preprod.alfah.de/ap-supplier-order-service\n\nProduction for ready to go systems: https://ap-cloud-service-gateway.alfah.de/ap-supplier-order-service\n",
      "image": "",
      "baseURL": "https://ap-cloud-service-gateway-preprod.alfah.de/ap-supplier-order-service",
      "humanURL": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/swaggerhub.alfah/ap-supplier-order-service-api/1.0",
      "version": "1.0",
      "tags": [
        "swaggerhub.alfah",
        "ap-supplier-order-service-api"
      ],
      "properties": [
        {
          "type": "OpenAPI",
          "name": "OpenAPI definition",
          "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/swaggerhub.alfah/ap-supplier-order-service-api/1.0/openapi.json",
          "mediaType": "application/openapi+json"
        },
        {
          "type": "GitHubRepo",
          "url": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/swaggerhub.alfah/ap-supplier-order-service-api/1.0"
        }
      ],
      "contact": [
        {
          "FN": "Sergei Biletnikov",
          "email": "sergei.biletnikov@alfah.de",
          "url": "https://alfah.de"
        }
      ]
    }
  ]
}