{"openapi":"3.0.4","info":{"title":"Upsert Order","description":"Upsert; update existing orders with given ids, or create new orders otherwise.","version":"0.0.1"},"servers":[{"url":"https://fbn-prd.lusid.com/api"}],"paths":{"/api/orders":{"post":{"tags":["Orders"],"summary":"Upsert Order","description":"Upsert; update existing orders with given ids, or create new orders otherwise.","operationId":"UpsertOrders","parameters":[{"name":"dataModelScope","in":"query","description":"The optional scope of a Custom Data Model to use","schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_]+$","type":"string"}},{"name":"dataModelCode","in":"query","description":"The optional code of a Custom Data Model to use","schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_]+$","type":"string"}}],"requestBody":{"description":"The collection of order requests.","content":{"application/json-patch+json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/OrderSetRequest"},"example":{"orderRequests":[{"properties":{"Order/MyScope/SomeOrderProperty":{"key":"Order/MyScope/SomeOrderProperty","value":{"labelValue":"XYZ000034567"}}},"instrumentIdentifiers":{"Instrument/default/Currency":"GBP"},"quantity":100,"side":"Buy","orderBookId":{"scope":"MyScope","code":"UKEQ-Orders"},"portfolioId":{"scope":"MyScope","code":"UK-Equity"},"id":{"scope":"MyScope","code":"ORD00000123"},"state":"New","type":"Limit","timeInForce":"GoodTilCancel","date":"2023-05-02T00:00:00.0000000+00:00","price":{"amount":534,"currency":"USD"},"orderInstruction":{"scope":"MyScope","code":"Instruction-06"},"package":{"scope":"MyScope","code":"UKEQ-Package"}}]}},"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/OrderSetRequest"},"example":{"orderRequests":[{"properties":{"Order/MyScope/SomeOrderProperty":{"key":"Order/MyScope/SomeOrderProperty","value":{"labelValue":"XYZ000034567"}}},"instrumentIdentifiers":{"Instrument/default/Currency":"GBP"},"quantity":100,"side":"Buy","orderBookId":{"scope":"MyScope","code":"UKEQ-Orders"},"portfolioId":{"scope":"MyScope","code":"UK-Equity"},"id":{"scope":"MyScope","code":"ORD00000123"},"state":"New","type":"Limit","timeInForce":"GoodTilCancel","date":"2023-05-02T00:00:00.0000000+00:00","price":{"amount":534,"currency":"USD"},"orderInstruction":{"scope":"MyScope","code":"Instruction-06"},"package":{"scope":"MyScope","code":"UKEQ-Package"}}]}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/OrderSetRequest"},"example":{"orderRequests":[{"properties":{"Order/MyScope/SomeOrderProperty":{"key":"Order/MyScope/SomeOrderProperty","value":{"labelValue":"XYZ000034567"}}},"instrumentIdentifiers":{"Instrument/default/Currency":"GBP"},"quantity":100,"side":"Buy","orderBookId":{"scope":"MyScope","code":"UKEQ-Orders"},"portfolioId":{"scope":"MyScope","code":"UK-Equity"},"id":{"scope":"MyScope","code":"ORD00000123"},"state":"New","type":"Limit","timeInForce":"GoodTilCancel","date":"2023-05-02T00:00:00.0000000+00:00","price":{"amount":534,"currency":"USD"},"orderInstruction":{"scope":"MyScope","code":"Instruction-06"},"package":{"scope":"MyScope","code":"UKEQ-Package"}}]}},"application/*+json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/OrderSetRequest"},"example":{"orderRequests":[{"properties":{"Order/MyScope/SomeOrderProperty":{"key":"Order/MyScope/SomeOrderProperty","value":{"labelValue":"XYZ000034567"}}},"instrumentIdentifiers":{"Instrument/default/Currency":"GBP"},"quantity":100,"side":"Buy","orderBookId":{"scope":"MyScope","code":"UKEQ-Orders"},"portfolioId":{"scope":"MyScope","code":"UK-Equity"},"id":{"scope":"MyScope","code":"ORD00000123"},"state":"New","type":"Limit","timeInForce":"GoodTilCancel","date":"2023-05-02T00:00:00.0000000+00:00","price":{"amount":534,"currency":"USD"},"orderInstruction":{"scope":"MyScope","code":"Instruction-06"},"package":{"scope":"MyScope","code":"UKEQ-Package"}}]}}},"required":true},"responses":{"201":{"description":"A collection of orders.","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ResourceListOfOrder"},"example":{"values":[{"properties":{"Order/MyScope/SomeOrderProperty":{"key":"Order/MyScope/SomeOrderProperty","value":{"labelValue":"XYZ000034567"}}},"version":{"effectiveFrom":"2018-03-05T10:10:10.0000000+00:00","asAtDate":"2018-03-05T10:10:10.0000000+00:00"},"instrumentIdentifiers":{"Instrument/default/Currency":"GBP"},"quantity":100,"side":"Buy","orderBookId":{"scope":"MyScope","code":"UKEQ-Orders"},"portfolioId":{"scope":"MyScope","code":"testPortfolio"},"id":{"scope":"MyScope","code":"ORD00000123"},"lusidInstrumentId":"lusidInstrumentId","state":"New","type":"Limit","timeInForce":"GoodTilCancel","date":"1999-06-05T00:00:00.0000000+00:00","stopPrice":{"amount":534,"currency":"USD"},"orderInstructionId":{"scope":"MyScope","code":"Instruction-06"},"packageId":{"scope":"MyScope","code":"UKEQ-Package"}}],"links":[]}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ResourceListOfOrder"},"example":{"values":[{"properties":{"Order/MyScope/SomeOrderProperty":{"key":"Order/MyScope/SomeOrderProperty","value":{"labelValue":"XYZ000034567"}}},"version":{"effectiveFrom":"2018-03-05T10:10:10.0000000+00:00","asAtDate":"2018-03-05T10:10:10.0000000+00:00"},"instrumentIdentifiers":{"Instrument/default/Currency":"GBP"},"quantity":100,"side":"Buy","orderBookId":{"scope":"MyScope","code":"UKEQ-Orders"},"portfolioId":{"scope":"MyScope","code":"testPortfolio"},"id":{"scope":"MyScope","code":"ORD00000123"},"lusidInstrumentId":"lusidInstrumentId","state":"New","type":"Limit","timeInForce":"GoodTilCancel","date":"1999-06-05T00:00:00.0000000+00:00","stopPrice":{"amount":534,"currency":"USD"},"orderInstructionId":{"scope":"MyScope","code":"Instruction-06"},"packageId":{"scope":"MyScope","code":"UKEQ-Package"}}],"links":[]}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ResourceListOfOrder"},"example":{"values":[{"properties":{"Order/MyScope/SomeOrderProperty":{"key":"Order/MyScope/SomeOrderProperty","value":{"labelValue":"XYZ000034567"}}},"version":{"effectiveFrom":"2018-03-05T10:10:10.0000000+00:00","asAtDate":"2018-03-05T10:10:10.0000000+00:00"},"instrumentIdentifiers":{"Instrument/default/Currency":"GBP"},"quantity":100,"side":"Buy","orderBookId":{"scope":"MyScope","code":"UKEQ-Orders"},"portfolioId":{"scope":"MyScope","code":"testPortfolio"},"id":{"scope":"MyScope","code":"ORD00000123"},"lusidInstrumentId":"lusidInstrumentId","state":"New","type":"Limit","timeInForce":"GoodTilCancel","date":"1999-06-05T00:00:00.0000000+00:00","stopPrice":{"amount":534,"currency":"USD"},"orderInstructionId":{"scope":"MyScope","code":"Instruction-06"},"packageId":{"scope":"MyScope","code":"UKEQ-Package"}}],"links":[]}}}},"400":{"description":"The details of the input related failure","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidValidationProblemDetails"}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidValidationProblemDetails"}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidValidationProblemDetails"}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidProblemDetails"}}}}},"security":[{"BearerAuth":[]}],"x-fbn-apistatus":"Stable"}}},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}}}