Skip to main content

Process order by lookup key

GET 
https://api.helice.cloud/api/t/v1/orders/:lookupKey/:lookupValue/process

Process an order by a specific lookupKey / lookupId combination.

lookupKeys
id
externalId

What are lookup keys?

Processing an order does the following:

  1. for each supplier in the order a purchase order and backorder is created
  2. the order is set to status CONFIRMED

Once an order is processed, shipments / track and trace codes can be booked on backorders.

Request​

Path Parameters

    lookupKey stringrequired

    Use id or externalId

    id - Integer

    lookupValue stringrequired

    The id or externalId of the order

    id - Integer, externalId - String

Responses​

Process order by lookup key - 200

Response Headers
    Alt-Svc
    Via
    alt-svc
    content-length
    date
    return-format
    server
    x-request-id
Schema
    data object
    clientData object
    abbreviationstring
    Example: JS
    companystring
    Example: Propellor
    dateOfBirthstring
    Example:
    debtorIdstring
    Example: 753953
    emailstring
    Example: julielarue@propellor.eu
    firstNamestring
    Example: Jullien
    fullNamestring
    Example: Jullien Serres
    genderstring
    Example: M
    idnumber
    Example: 14718
    lastNamestring
    Example: Serres
    loginstring
    Example: julielarue@propellor.eu
    middleNamestring
    Example:
    mobilestring
    Example: 06-12345678
    phonestring
    Example: 020-6717171
    ssnstring
    Example:
    titlestring
    Example:
    vatNumberstring
    Example:
    datestring
    Example: 2022-03-16T15:00:55
    debtorIdstring
    Example: 753953
    emailstring
    Example:
    externalIdstring
    Example:
    extraInfostring
    Example:
    firstNamestring
    Example: Julien
    idnumber
    Example: 195
    invoiceData object
    address object
    activestring
    Example: Y
    citystring
    Example: Apeldoorn
    codestring
    Example:
    companystring
    Example:
    countrystring
    Example: NL
    emailstring
    Example: w.spies@propel.us
    faxstring
    Example:
    firstNamestring
    Example: Julien
    genderstring
    Example: U
    icpstring
    Example: N
    idnumber
    Example: 81902
    isDefaultstring
    Example: N
    lastNamestring
    Example: Serres
    middleNamestring
    Example:
    mobilestring
    Example:
    namestring
    Example:
    notesstring
    Example:
    numberstring
    Example:
    numberExtensionstring
    Example:
    phonestring
    Example: +31206717171
    postalCodestring
    Example: 7323 KE
    regionstring
    Example:
    streetstring
    Example: Mazurkastraat 20
    typestring
    Example: invoice
    urlstring
    Example:
    itemCountnumber
    Example: 1
    languagestring
    Example: EN-US
    lastNamestring
    Example: Serres
    middleNamestring
    Example:
    paymentData object
    grossAmountnumber
    Example: 0
    netAmountnumber
    Example: 0
    payMethodstring
    Example:
    payStatusstring
    Example:
    paystatusdatestring
    Example:
    taxnumber
    Example: 0
    taxPercentagenumber
    Example: 21
    transactionIdstring
    Example:
    postageData object
    carrierstring
    Example:
    partialDeliveryAllowedstring
    Example: Y
    postagenumber
    Example: 0
    postageNetnumber
    Example: 0
    postageTaxPercentagenumber
    Example: 21
    requestDatestring
    Example:
    shippingMethodstring
    Example:
    referencestring
    Example:
    remarksstring
    Example:
    shippingData object
    address object
    activestring
    Example: Y
    citystring
    Example: Apeldoorn
    codestring
    Example:
    companystring
    Example:
    countrystring
    Example: NL
    emailstring
    Example:
    faxstring
    Example:
    firstNamestring
    Example: Julien
    genderstring
    Example: U
    icpstring
    Example: N
    idnumber
    Example: 81903
    isDefaultstring
    Example: N
    lastNamestring
    Example: Serres
    middleNamestring
    Example:
    mobilestring
    Example:
    namestring
    Example:
    notesstring
    Example:
    numberstring
    Example: 20
    numberExtensionstring
    Example:
    phonestring
    Example:
    postalCodestring
    Example: 7323 KE
    regionstring
    Example:
    streetstring
    Example: Mazurkastraat
    typestring
    Example: delivery
    urlstring
    Example:
    shopIdnumber
    Example: 1
    siteIdnumber
    Example: 100037
    sourcestring
    Example: intern
    statusstring
    Example: CONFIRMED
    total object
    discountPercentagenumber
    Example: 0
    discountValuenumber
    Example: 0
    tax object
    11number
    Example: 32.2234
    21number
    Example: 0
    totalGrossnumber
    Example: 292.94
    totalNetnumber
    Example: 325.1634
    typestring
    Example: dropshipment
    userIdnumber
    Example: 14718
    messagesstring[]
    Example: ["Order processed"]
    totalnumber
    Example: 1

Authorization: OAuth2

name: OAuth2type: oauth2bearerFormat: tokenscheme: bearerdescription: OAuth2 Authorizationin: headerflows: {
  "clientCredentials": {
    "tokenUrl": "https://api.helice.cloud/oauth2/token/",
    "scopes": {}
  }
}
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.helice.cloud/api/t/v1/orders/:lookupKey/:lookupValue/process");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <OAuth2>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://api.helice.cloud/api/t/v1
Auth
Parameters
— pathrequired
— pathrequired
ResponseClear

Click the Send API Request button above and see the response here!