COMMERCE QUERY

Query API 3.0

RecurringOrderSchedule

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

https://norcecommerce.api-se.norce.tech/commerce/query/3.0/

Schemas

RecurringOrder

idinteger(int32)

The recurring order identifier.

clientIdinteger(int32)

The client identifier.

applicationIdinteger(int32)

The application identifier.

typeIdinteger(int32)

The recurring order type identifier.

templateQuotationIdinteger(int32)

The identifier of the template quotation used to generate new orders.

statusIdinteger(int32)

The recurring order status identifier.

holdFromDatestring or null(date-time)

The date and time from which the recurring order is held (paused).

holdUntilDatestring or null(date-time)

The date and time until which the recurring order is held (paused).

startDatestring or null(date-time)

The date and time the recurring order starts.

endDatestring or null(date-time)

The date and time the recurring order ends.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger or null(int32)

The identifier of the user who last updated the record.

schedulesArray of objects or null(RecurringOrderSchedule)

type(RecurringOrderType (object or null))

One of:

templateQuotation(Quotation (object or null))

One of:

{
  "id": 0,
  "clientId": 0,
  "applicationId": 0,
  "typeId": 0,
  "templateQuotationId": 0,
  "statusId": 0,
  "holdFromDate": "2019-08-24T14:15:22Z",
  "holdUntilDate": "2019-08-24T14:15:22Z",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "schedules": [
    { … }
  ],
  "type": {
    "id": 0,
    "clientId": 0,
    "applicationId": 0,
    "code": "string",
    "name": "string",
    "description": "string",
    "endDate": "2019-08-24T14:15:22Z",
    "isActive": true,
    "stoppedDate": "2019-08-24T14:15:22Z",
    "stoppedBy": 0,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "recurringOrder": [ … ]
  },
  "templateQuotation": {
    "id": 0,
    "applicationId": 0,
    "salesContactId": 0,
    "buyerAccountKey": "string",
    "buyerAccountId": 0,
    "payerAccountId": 0,
    "payerAccountKey": "string",
    "statusId": 0,
    "isPrimary": true,
    "name": "string",
    "validTo": "2019-08-24T14:15:22Z",
    "isDeletable": true,
    "comment": "string",
    "rejectionReasonId": 0,
    "modified": "2019-08-24T14:15:22Z",
    "browsed": "2019-08-24T14:15:22Z",
    "paymentMethodId": 0,
    "deliveryMethodId": 0,
    "ipAddress": "string",
    "payerFirstName": "string",
    "payerMiddleName": "string",
    "payerLastName": "string",
    "payerCellPhoneNumber": "string",
    "payerEmail": "string",
    "currencyId": 0,
    "resellerCustomerId": 0,
    "isLocked": true,
    "discountCode": "string",
    "isActive": true,
    "parentQuotationId": 0,
    "clientId": 0,
    "buyerCompanyId": 0,
    "payerCompanyId": 0,
    "hasPaymentTransaction": true,
    "buyerFirstName": "string",
    "buyerMiddleName": "string",
    "buyerLastName": "string",
    "buyerCellPhoneNumber": "string",
    "buyerEmail": "string",
    "customerOrderReference": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "referId": 0,
    "referUrl": "string",
    "payerSocialSecurityNumber": "string",
    "buyerCustomerId": 0,
    "payerCustomerId": 0,
    "shipToCustomerId": 0,
    "rowId": "string",
    "deleteDate": "2019-08-24T14:15:22Z",
    "pickupCode": "string",
    "attestedBy": 0,
    "modifiedBy": 0,
    "typeId": 0,
    "doHold": true,
    "deliveryMethodCode": "string",
    "freightPrice": 0,
    "customerInvoiceReference": "string",
    "year": 0,
    "week": 0,
    "salesAreaId": 0,
    "payerPhoneNumber": "string",
    "buyerPhoneNumber": "string",
    "externalDiscountCode": "string",
    "order": [ … ],
    "addresses": [ … ],
    "infos": [ … ],
    "items": [ … ],
    "recurringOrder": [ … ]
  }
}

RecurringOrderSchedule

idinteger(int32)

The recurring order schedule identifier.

clientIdinteger(int32)

The client identifier.

applicationIdinteger(int32)

The application identifier.

recurringOrderIdinteger(int32)

The recurring order identifier.

frequencyIdinteger(int32)

The recurring order schedule frequency identifier.

recurValueinteger(int32)

The recurrence value used in combination with the frequency (e.g. every N weeks).

weeklyMondayboolean

Indicates whether the schedule runs on Mondays.

weeklyTuesdayboolean

Indicates whether the schedule runs on Tuesdays.

weeklyWednesdayboolean

Indicates whether the schedule runs on Wednesdays.

weeklyThursdayboolean

Indicates whether the schedule runs on Thursdays.

weeklyFridayboolean

Indicates whether the schedule runs on Fridays.

weeklySaturdayboolean

Indicates whether the schedule runs on Saturdays.

weeklySundayboolean

Indicates whether the schedule runs on Sundays.

monthlyDayinteger(int32)

The day of month the schedule runs on.

monthlyIntervalIdinteger(int32)

The monthly interval identifier (e.g. first, last).

monthlyIntervalValueIdinteger(int32)

The monthly interval value identifier (e.g. Monday, weekday).

timeOfDaystring or null(duration)

The time of day the schedule runs at.

nextRunstring or null(date-time)

isActiveboolean

Indicates whether the schedule is active.

stoppedDatestring or null(date-time)

The date and time the schedule was stopped.

stoppedByinteger or null(int32)

The identifier of the user who stopped the schedule.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger or null(int32)

The identifier of the user who last updated the record.

recurringOrder(RecurringOrder (object or null))

One of:

{
  "id": 0,
  "clientId": 0,
  "applicationId": 0,
  "recurringOrderId": 0,
  "frequencyId": 0,
  "recurValue": 0,
  "weeklyMonday": true,
  "weeklyTuesday": true,
  "weeklyWednesday": true,
  "weeklyThursday": true,
  "weeklyFriday": true,
  "weeklySaturday": true,
  "weeklySunday": true,
  "monthlyDay": 0,
  "monthlyIntervalId": 0,
  "monthlyIntervalValueId": 0,
  "timeOfDay": "string",
  "nextRun": "2019-08-24T14:15:22Z",
  "isActive": true,
  "stoppedDate": "2019-08-24T14:15:22Z",
  "stoppedBy": 0,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "recurringOrder": {
    "id": 0,
    "clientId": 0,
    "applicationId": 0,
    "typeId": 0,
    "templateQuotationId": 0,
    "statusId": 0,
    "holdFromDate": "2019-08-24T14:15:22Z",
    "holdUntilDate": "2019-08-24T14:15:22Z",
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "schedules": [ … ],
    "type": { … },
    "templateQuotation": { … }
  }
}

RecurringOrderType

idinteger(int32)

The recurring order type identifier.

clientIdinteger(int32)

The client identifier.

applicationIdinteger(int32)

The application identifier.

codestring[ 0 .. 50 ] charactersrequired

The code of the recurring order type.

namestring[ 0 .. 50 ] charactersrequired

The name of the recurring order type.

descriptionstring or null[ 0 .. 500 ] characters

The description of the recurring order type.

endDatestring or null(date-time)

The date and time the recurring order type ends.

isActiveboolean

Indicates whether the recurring order type is active.

stoppedDatestring or null(date-time)

The date and time the recurring order type was stopped.

stoppedByinteger or null(int32)

The identifier of the user who stopped the recurring order type.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger or null(int32)

The identifier of the user who last updated the record.

recurringOrderArray of objects or null(RecurringOrder)

{
  "id": 0,
  "clientId": 0,
  "applicationId": 0,
  "code": "string",
  "name": "string",
  "description": "string",
  "endDate": "2019-08-24T14:15:22Z",
  "isActive": true,
  "stoppedDate": "2019-08-24T14:15:22Z",
  "stoppedBy": 0,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "recurringOrder": [
    { … }
  ]
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations