OSCA DC Order Interface API (1.0.0)

Download OpenAPI specification: Download

E-mail: interfaces@setlog-support.com

Setlog Service for import purchase orders

Upload purchase orders

PUT/order

Upload new or changed purchase orders from ERP-System into your OSCA System.

Authorizations: http

parameter name:

Request Body Schema: application/json

an object with a list of new or changed purchase orders

array of PurchaseOrder

List of purchase orders to upload

accountingArea

string

Accounting separation of an area of an enterprise

object (Partner)

buyingTeam

string

Team of purchasers that is responsible for the purchase of certain items

cancelled

boolean

If set to true, all related positions will be cancelled. Additionally only the "purchaseOrderNumber" and "cancelled" field are required. To cancel individual Purchase Order Lines, set the cancelled flag within the corresponding PurchaseOrderLine

object (Partner)

currency

string

Currency in which supplier is payed by the customer, 3 character ISO-Code according to ISO 4217

object

Additional attributs as a custom object. Unknown fields on PurchaseOrder will be interpreted as being part of this object instead.

department

string

This is the information about department of an enterprise, which is responsible for this order.

division

string

This is the information about devision of an enterprise, which is responsible for this order.

orderDate

string <date>

Date of order creation.

orderKind

string

This is the information about the kind of the PurchaseOrder.

orderType

string

This is the information about the typification of the PurchaseOrder.

paymentTerms

string

Conditions concerning the payment obligations of a purchaser

required

array of PurchaseOrderLine

Purchase order lines

array of Breakdown

Color-size break down

campaign

string

Special advertisement or marketing campaign a purchase order refers to

cancelled

boolean

Defines if a position is cancelled. The default value is false

channel

string

Name of distribution channel or customer or target group

channelIncoterm

string

Incoterm from customers warehouse/ DC to its customer

contractNumber

string

Contract order number that precedes a normal purchase order and to which a purchase order can refer to

contractPosition

integer <int32>

Position of a contract order

countryOfOrigin

string

Country of origin: unlocode (2 digit), https://unece.org/trade/cefact/unlocode-code-list-country-and-territory

crd

string <date>

Cargo ready date

object

Individual attributes (fields) as a freely structured json object for a purchase order line

dispatchType

string

Enum: "flat packed""hanging"

The way products are transported, flat packed or hanging

object (Partner)

eta

string <date>

Estimated Date of Arrival

etd

string <date>

Estimated Time of Departure

exFactoryDate

string <date>

Date when items leave /are intended to leave the factory

object (Partner)

handoverDate

string <date>

Date when items are handed over/are intended to be handed over from factory to forwarder

object (Partner)

incoterm

string

International commercial terms:3 digit (2020); https://en.wikipedia.org/wiki/Incoterms

object (Partner)

required

array of Item

Product as described in item

object (Partner)

mot

string

Enum: "SEA""AIR""SEA-AIR""TRUCK""RAIL""COURIER"

Mode of transportation between POL and POA

motHaulage

string

Enum: "TRUCK""RAIL""BARGE""COURIER"

Mode of transporation for on carriage

orderSet

string

Link/connection to other orders

poa

string

Port of arrival: 5-Digit unlocode; https://unece.org/trade/cefact/unlocode-code-list-country-and-territory

pol

string

Port of loading: 5-Digit unlocode; https://unece.org/trade/cefact/unlocode-code-list-country-and-territory

position required

string

Position of the purchase order line, unique for each line of the purchase order

price

number <double>

Purchase cost for position

priority

boolean

Defines the priority of the order line. The default value is false

quantity

integer <int32>

Order quantity for the position

object (Partner)

remark

string

Purchase Order Line remark

service

string

Service level of a type of transport (especially for airfreight, a distinction is made between different service levels (A, B, C).

object (Partner)

targetDate1

string <date>

First planning date, when goods should be at the destination

targetDate2

string <date>

Second planning date, when goods should be at the destination

targetDate3

string <date>

Third planning date, when goods should be at the destination

toleranceHigh

number <double>

Tolerance for overdelivery in percent

toleranceLow

number <double>

Tolerance for underdelivery in percent

unitOfPrice

integer <int32>

Unit of price

purchaseOrderNumber required

string

Purchase Order Number. This value must be unique and also case insensitive. If any existing value is used, then OSCA matches existing "PurchaseOrder" with this "PurchaseOrder" and updates (or cancelled, if cancelled field for all "PurchaseOrderLine"s is set to true) the existing "PurchaseOrder".

purchaser

string

This is the information about person, who responsible for purchasing.

required

object (Partner)

Responses

› 200 The uploaded purchase orders are saved successfully. It could be that due to the configuration in your OSCA System, some values for the shipment are overridden.

Response Schema

array of object

object

The metadata of the execution of the request

array of object

› 400 This means that the entity has the required fields but some fields are missing during the process. This can occur, when you define default fields but they are not taken.

Response Schema

array of object

object

The metadata of the execution of the request

array of object

› 401 This means that you are unauthorized.

Response Schema

value

object

› 422 This means that the request is not well-formed, or syntactically incorrect, or violates schema.

Response Schema

object

The metadata of the execution of the request

array of object

Workflow

OSCA DC Order Interface API (1.0.0)

Upload purchase orders

PUT/order

Request Body Schema: application/json

Responses

Response Schema

Response Schema

Response Schema

Response Schema