{ "openapi": "3.0.0", "info": { "version": "1.0", "title": "Order Tracking For Business France API", "description": "Order Tracking for Business API allows you monitor and track your orders progress all the way through to delivery and completion.\n\n\nCopyright © Orange Business 2023. All Rights Reserved.\n\n \n# Authentication\n \nThe authentication is based on OAuth 2.0 and and API Key provided by Orange Business", "contact": { "url": "https://developer.orange.com", "email": "api.tech-expert@orange.com", "name": "Technical Expert Team" } }, "tags": [ { "name": "Order", "description": "Order Controller" }, { "name": "Document", "description": "Document Controller" }, { "name": "Service", "description": "Service Controller" }, { "name": "Appointment", "description": "Appointment Controller" }, { "name": "Miscellaneous", "description": "Swagger file, API status, API version and API user information" } ], "servers": [ { "url": "https://api.orange.com/order-tracking/b2b/v1", "description": "Orange Developer" } ], "paths": { "/orders": { "get": { "tags": [ "Order" ], "summary": "Return list of orders", "description": "Return list of orders", "operationId": "get-orders", "parameters": [ { "$ref": "#/components/parameters/apiKey" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/sort" }, { "name": "status", "in": "query", "description": "status of the orders : Current or Closed or Cancelled", "required": true, "schema": { "type": "string", "example": "Current", "enum": [ "Current", "Closed", "Cancelled" ] } }, { "name": "displayNulls", "in": "query", "description": "display nulls", "required": false, "schema": { "type": "boolean", "default": 0, "enum": [ 0, 1 ] } }, { "name": "id", "in": "query", "description": "order id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } } }, "headers": { "X-Total-Count": { "schema": { "type": "integer", "format": "int32" }, "description": "The total number of items matching criterias." }, "X-Result-Count": { "schema": { "type": "integer", "format": "int32" }, "description": "The actual number of items returned in the response body." } } }, "401": { "$ref": "#/components/responses/Error-Unauthorized" }, "403": { "$ref": "#/components/responses/Error-Forbidden" }, "500": { "$ref": "#/components/responses/Error-Internal" } } } }, "/orders/{orderId}": { "get": { "tags": [ "Order" ], "summary": "Return order element", "description": "Return single order", "operationId": "get-order-by-id", "parameters": [ { "$ref": "#/components/parameters/apiKey" }, { "name": "orderId", "in": "path", "description": "order ID", "required": true, "schema": { "type": "string" } }, { "name": "displayNulls", "in": "query", "description": "display nulls", "required": false, "schema": { "type": "boolean", "default": 0, "enum": [ 0, 1 ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "401": { "$ref": "#/components/responses/Error-Unauthorized" }, "403": { "$ref": "#/components/responses/Error-Forbidden" }, "404": { "$ref": "#/components/responses/Error-NotFound" }, "500": { "$ref": "#/components/responses/Error-Internal" } } } }, "/orders/{orderId}/documents": { "get": { "tags": [ "Document" ], "summary": "Retrieve a list of documents related to an order by order's ID", "description": "Retrieve a list of documents related to an order by order's ID", "operationId": "get-orders-orderId-documents", "parameters": [ { "$ref": "#/components/parameters/apiKey" }, { "name": "orderId", "in": "path", "description": "Single Identifier of an Order.", "required": true, "schema": { "type": "string" } }, { "name": "displayNulls", "in": "query", "description": "Flag for displaying all attributes even if the value is null.", "schema": { "type": "boolean", "default": 0, "enum": [ 0, 1 ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Document" } } } }, "headers": { "X-Total-Count": { "schema": { "type": "integer", "format": "int32" }, "description": "The total number of items matching criterias." }, "X-Result-Count": { "schema": { "type": "integer", "format": "int32" }, "description": "The actual number of items returned in the response body." } } }, "401": { "$ref": "#/components/responses/Error-Unauthorized" }, "403": { "$ref": "#/components/responses/Error-Forbidden" }, "500": { "$ref": "#/components/responses/Error-Internal" } } } }, "/orders/{orderId}/documents/{documentId}": { "get": { "tags": [ "Document" ], "summary": "get order document file", "description": "This method allows the download of an individual document", "operationId": "GetOrderDocumentFile", "parameters": [ { "$ref": "#/components/parameters/apiKey" }, { "name": "orderId", "in": "path", "description": "Single Identifier of a request", "required": true, "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "description": "Single Identifier of a file.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "title": "file content", "description": "This is the content of the file in binary format", "type": "string", "format": "binary" } } } }, "401": { "$ref": "#/components/responses/Error-Unauthorized" }, "403": { "$ref": "#/components/responses/Error-Forbidden" }, "404": { "$ref": "#/components/responses/Error-NotFound" }, "500": { "$ref": "#/components/responses/Error-Internal" } } } }, "/orders/{orderId}/services": { "get": { "tags": [ "Service" ], "summary": "Retrieve a list of order services by order id", "description": "Retrieve a list of order services by order id", "operationId": "get-orders-orderId-services", "parameters": [ { "$ref": "#/components/parameters/apiKey" }, { "name": "orderId", "in": "path", "description": "order id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Order-Service" } } } }, "headers": { "X-Total-Count": { "schema": { "type": "integer", "format": "int32" }, "description": "The total number of items matching criterias." }, "X-Result-Count": { "schema": { "type": "integer", "format": "int32" }, "description": "The actual number of items returned in the response body." } } }, "401": { "$ref": "#/components/responses/Error-Unauthorized" }, "403": { "$ref": "#/components/responses/Error-Forbidden" }, "500": { "$ref": "#/components/responses/Error-Internal" } } } }, "/orders/{orderId}/services/{serviceId}/appointments": { "get": { "tags": [ "Appointment" ], "summary": "Get service and appointments detail on the current milestone", "description": "Get service and appointments detail on the current milestone", "operationId": "get-orders-orderId-services-serviceId-appointments", "parameters": [ { "$ref": "#/components/parameters/apiKey" }, { "name": "orderId", "in": "path", "description": "order id", "required": true, "schema": { "type": "string" } }, { "name": "serviceId", "in": "path", "description": "service id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Order-Appointment" } } } }, "headers": { "X-Total-Count": { "schema": { "type": "integer", "format": "int32" }, "description": "The total number of items matching criterias." }, "X-Result-Count": { "schema": { "type": "integer", "format": "int32" }, "description": "The actual number of items returned in the response body." } } }, "401": { "$ref": "#/components/responses/Error-Unauthorized" }, "403": { "$ref": "#/components/responses/Error-Forbidden" }, "500": { "$ref": "#/components/responses/Error-Internal" } } } }, "/doc": { "get": { "summary": "get API specification document", "tags": [ "Miscellaneous" ], "description": "get the documentation for this API", "operationId": "get-doc", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "description": "the swagger file for this API in json format" } } } }, "401": { "$ref": "#/components/responses/Error-Unauthorized" }, "403": { "$ref": "#/components/responses/Error-Forbidden" }, "500": { "$ref": "#/components/responses/Error-Internal" } }, "security": [ { "token": [] } ], "servers": [ { "url": "https://api.orange.com/order-tracking/b2b/v1", "description": "Orange Developer" } ] } }, "/status": { "get": { "summary": "get api status", "tags": [ "Miscellaneous" ], "description": "get the API status", "operationId": "get-status", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } } }, "401": { "$ref": "#/components/responses/Error-Unauthorized" }, "403": { "$ref": "#/components/responses/Error-Forbidden" }, "500": { "$ref": "#/components/responses/Error-Internal" } }, "security": [ { "token": [] } ], "servers": [ { "url": "https://api.orange.com/order-tracking/b2b/v1", "description": "Orange Developer" } ] } }, "/version": { "get": { "summary": "get api version", "tags": [ "Miscellaneous" ], "description": "get the API version", "operationId": "get-version", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Version" } } } }, "401": { "$ref": "#/components/responses/Error-Unauthorized" }, "403": { "$ref": "#/components/responses/Error-Forbidden" }, "500": { "$ref": "#/components/responses/Error-Internal" } }, "security": [ { "token": [] } ], "servers": [ { "url": "https://api.orange.com/order-tracking/b2b/v1", "description": "Orange Developer" } ] } }, "/me": { "get": { "summary": "get user information", "tags": [ "Miscellaneous" ], "description": "This endpoint provides information on the connected user.", "operationId": "get-me", "parameters": [ { "$ref": "#/components/parameters/apiKey" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ME" } } } }, "401": { "$ref": "#/components/responses/Error-Unauthorized" }, "403": { "$ref": "#/components/responses/Error-Forbidden" }, "404": { "$ref": "#/components/responses/Error-NotFound" }, "500": { "$ref": "#/components/responses/Error-Internal" } } } } }, "components": { "parameters": { "sort": { "name": "sort", "in": "query", "description": "sort the output ascending or descending", "required": false, "style": "form", "explode": false, "schema": { "type": "string", "items": { "description": "sort the output ascending or descending for a given property", "type": "string", "example": "-createdAt" } } }, "offset": { "name": "offset", "in": "query", "description": "Offset pagination determines the starting point within the collection of resource results", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 0, "default": 0 } }, "limit": { "name": "limit", "in": "query", "description": "Limit pagination controls the maximum of results to return", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 0, "default": 25 } }, "apiKey": { "name": "X-API-KEY", "in": "header", "description": "The API Key required for using Orange Business API.", "required": true, "schema": { "type": "string" } } }, "securitySchemes": { "token": { "type": "oauth2", "flows": { "clientCredentials": { "refreshUrl": "", "scopes": {}, "tokenUrl": "" } } } }, "responses": { "Error-Unauthorized": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Error-Forbidden": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Error-Internal": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Error-NotFound": { "description": "Resource not found Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "schemas": { "Document": { "type": "object", "description": "", "properties": { "name": { "type": "string", "description": "" }, "description": { "type": "string", "description": "" }, "content": { "type": "string", "format": "byte", "description": "base64-encoded file contents" } } }, "Order": { "type": "object", "description": "This schema describes an Orange order, with all its various properties, including the ordered service details, pricing, location, and various delivery milestones", "properties": { "id": { "type": "string", "description": "Orange Single Identifier of the Order", "example": "123456" }, "request": { "type": "object", "description": "The request associated with this order", "properties": { "id": { "type": "string", "description": "The Orange identifier of the request", "example": "3-0000000" }, "customerReference": { "type": "string", "description": "customerReference", "example": "" }, "status": { "type": "string", "description": "status", "example": "" }, "orangeContact": { "type": "object", "description": "orangeContact", "properties": { "name": { "type": "string", "description": "contact name", "example": "" }, "phone1": { "type": "string", "description": "contact phone1", "example": "" }, "phone2": { "type": "string", "description": "contact phone2", "example": "" }, "email": { "type": "string", "description": "contact email", "example": "" }, "role": { "type": "string", "description": "contact role", "example": "" } } }, "keyDates": { "type": "object", "description": "keyDates", "properties": { "completedAt": { "type": "string", "format": "date-time", "description": "completedAt", "example": "2023-05-03 00:00:00" }, "expectedAt": { "type": "string", "format": "date-time", "description": "expectedAt", "example": "2023-05-03 00:00:00" }, "cancelledAt": { "type": "string", "format": "date-time", "description": "cancelledAt", "example": "2023-05-03 00:00:00" }, "launchedCallAt": { "type": "string", "format": "date-time", "description": "launchedCallAt", "example": "2023-05-03 00:00:00" }, "validatedAt": { "type": "string", "format": "date-time", "description": "validatedAt", "example": "2023-05-03 00:00:00" } } }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date of the item for efficient data synchronization. There is no Business meaning. The format is [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format.", "example": "2023-01-25 12:05:37" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update of the item for efficient data synchronization. There is no Business meaning. The format is [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format.", "example": "2023-01-25 12:05:37" } } } } }, "Order-Service": { "type": "object", "description": "schema used to describe the services of an order", "properties": { "id": { "type": "string", "description": "unique identifier of the order service" }, "offer": { "type": "object", "description": "offer", "properties": { "id": { "type": "string", "description": "offer id", "example": "OC00000001419" }, "name": { "type": "string", "description": "offer name", "example": "Business Voix et Collaboration" } } }, "installNumber": { "type": "string", "description": "" }, "category": { "type": "string", "description": "", "enum": [ "ACTIVATE", "ADD", "DELETE", "MIGRATE", "MODIFY", "MODIFY_ACCOUNT" ] }, "status": { "type": "string", "description": "", "example": "Current", "enum": [ "Closed", "Cancelled", "Current", "A planifier" ] }, "currentMilestone": { "type": "string", "description": "", "enum": [ "Réception", "Raccordement réseau", "Installation Service", "Mise en Service" ] }, "location": { "type": "object", "description": "location", "properties": { "id": { "type": "string", "description": "location id", "example": "" }, "name": { "type": "string", "description": "location name", "example": "" }, "customerReference": { "type": "string", "description": "location customerReference", "example": "" }, "href": { "type": "string", "description": "location href", "example": "/locations/3-260471" }, "address": { "type": "object", "description": "address", "properties": { "street": { "type": "string", "description": "street", "example": "8 AVENUE HOCHE" }, "postalCode": { "type": "string", "description": "postalCode", "example": "75008" }, "city": { "type": "string", "description": "city", "example": "PARIS" } } } } }, "keyDates": { "type": "object", "description": "keyDates", "properties": { "completionAt": { "type": "string", "format": "date-time", "description": "completionAt", "example": "2023-05-03 00:00:00" } } }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date of the item. The format is [ISO-8601](https://www.w3.org/TR/NOTE-date-time) ", "example": "2023-06-19T15:12:16Z" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update of the item. The format is [ISO-8601](https://www.w3.org/TR/NOTE-date-time) ", "example": "2023-06-19T15:12:16Z" } } }, "Order-Appointment": { "type": "object", "description": "schema used to describe the appointment of an order", "properties": { "type": { "type": "string", "description": "", "enum": [ "ACCESS", "SERVICE" ] }, "subType": { "type": "string", "description": "", "enum": [ "NOMINAL", "SECOURS" ] }, "status": { "type": "string", "description": "", "enum": [ "FAILURE", "CANCELED", "UNKNOWN", "FINISHED", "APLANIFIER", "CONFIRME" ] }, "milestone": { "type": "array", "items": { "$ref": "#/components/schemas/Order-Milestone" } }, "keyDates": { "type": "object", "description": "keyDates", "properties": { "appointmentStartAt": { "type": "string", "format": "date-time", "description": "completionAt", "example": "2023-05-03 00:00:00" }, "appointmentEndAt": { "type": "string", "format": "date-time", "description": "completionAt", "example": "2023-05-03 00:00:00" } } }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date of the item. The format is [ISO-8601](https://www.w3.org/TR/NOTE-date-time) ", "example": "2023-06-19T15:12:16Z" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update of the item. The format is [ISO-8601](https://www.w3.org/TR/NOTE-date-time) ", "example": "2023-06-19T15:12:16Z" } } }, "Order-Milestone": { "type": "object", "description": "schema used to describe the milestone of an order", "properties": { "stepOrder": { "type": "string", "description": "", "example": "1" }, "label": { "type": "string", "description": "", "example": "Réception" }, "description": { "type": "string", "description": "", "example": "Lors de cette réunion, nous vérifions ensemble les informations liées à votre commande et présentons un planning de déploiement." }, "current": { "type": "boolean", "description": "", "example": true } } }, "Status": { "type": "object", "description": "this describes the current status of the API", "properties": { "name": { "type": "string", "description": "name of the API" }, "status": { "enum": [ "ok", "ko" ], "type": "string", "description": "status of the API" }, "version": { "type": "string", "description": "version of the API" } }, "example": { "name": "API Ordering For Business 2.1", "status": "ok", "version": "2.1.0" } }, "Version": { "type": "object", "description": "this describes the current version of the API", "properties": { "version": { "type": "object", "description": "version of the API", "properties": { "major": { "type": "string", "description": "major release number" }, "minor": { "type": "string", "description": "minor release number" }, "patch": { "type": "string", "description": "patch release number" } } }, "deprecated": { "type": "boolean", "description": "is the current version deprecated" } }, "example": { "version": { "major": "2", "minor": "1", "patch": "0" }, "deprecated": false } }, "Error": { "type": "object", "description": "Information on the error.", "properties": { "code": { "type": "integer", "description": "Internal Code of the error.", "format": "int32" }, "message": { "type": "string", "description": "Title of the error." }, "description": { "type": "string", "description": "Details on the error." }, "infoURL": { "type": "string", "description": "URI on more information on the error" } }, "required": [ "code", "message" ] }, "ME": { "title": "Me", "type": "object", "description": "Information on the connected user and the API Key.", "properties": { "id": { "type": "string", "description": "Single Identifier of the API key." }, "login": { "type": "string", "description": "Login of the associated user." }, "name": { "type": "string", "description": "Name of the associated user." }, "phone": { "type": "string", "description": "Phone number of the associated user." }, "mobile": { "type": "string", "description": "Mobile number of the associated user." }, "email": { "type": "string", "description": "Email address of the associated user." }, "application": { "type": "object", "description": "Application identifier in Orange Developer Portal.", "properties": { "id": { "type": "string", "description": "Orange Single Identifier of the application in the Orange Developer Portal." }, "name": { "type": "string", "description": "Name of the application in Orange Developer Portal." } } }, "apiKey": { "type": "object", "description": "Token identifier associated to the API Key.", "properties": { "id": { "type": "string", "description": "Orange Single Identifier of the API KEY." }, "status": { "type": "string", "description": "status of the api key", "enum": [ "ACTIVE", "EXPIRED", "SUSPENDED" ] }, "scopes": { "type": "string", "description": "Scopes defined for the API Key for Machine to Machine connection, or negotiated scopes for User to Machine connection." }, "type": { "type": "string", "description": "Type of the environment (Sandbox or Production).", "enum": [ "SANDBOX", "PRODUCTION" ] }, "createdAt": { "type": "string", "format": "date-time", "description": "Date of the creation of the API Key." }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update date of the API Key." }, "expireAt": { "type": "string", "description": "Date of the expiration of the API Key." } } }, "createdAt": { "type": "string", "description": "Date of the creation of the User Account." }, "updatedAt": { "type": "string", "description": "Last update date of the User Account." } } } } } }