Import

Server

Imports

This focuses on requests to fetch eTIMS imports, create an eTIMS import item, and get a list of eTIMS imports

Get etims imports list

GET

https://api-dev.slade360edi.com/erp

/api/etims/etims_imports

Etims Import Viewset.

Get etims imports list › Headers

Accept

string · required · style: simple

Get etims imports list › Responses

200

count

string · required

next

string · required

previous

string · required

Result6[] · required

GET/api/etims/etims_imports

curl https://api-dev.slade360edi.com/erp/api/etims/etims_imports \
  --header 'Accept: <string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "count": "<integer>",
  "next": "<uri>",
  "previous": "<uri>",
  "results": [
    {
      "id": "<integer>",
      "item_name": "<string>",
      "package": "<double>",
      "product_code": "<string>",
      "product_name": "<string>",
      "quantity": "<integer>",
      "task_code": "<string>",
      "declaration_date": "<string>",
      "item_sequence": "<integer>",
      "declaration_number": "<string>",
      "hs_code": "<string>",
      "import_item_status_code": "<string>",
      "origin_nation_code": "<string>",
      "export_nation_code": "<string>",
      "packaging_unit_code": "<string>",
      "quantity_unit_code": "<string>",
      "gross_weight": "<double>",
      "net_weight": "<double>",
      "supplier_name": "<string>",
      "agent_name": "<string>",
      "invoice_foreign_currency_amount": "<double>",
      "invoice_foreign_currency_code": "<string>",
      "invoice_foreign_currency_exchange": "<double>",
      "workflow_state": "ARCHIVED",
      "sent_to_etims": "<boolean>",
      "organisation": "<uuid>",
      "branch": "<uuid>",
      "product": "<uuid>"
    },
    {
      "id": "<integer>",
      "item_name": "<string>",
      "package": "<double>",
      "product_code": "<string>",
      "product_name": "<string>",
      "quantity": "<integer>",
      "task_code": "<string>",
      "declaration_date": "<string>",
      "item_sequence": "<integer>",
      "declaration_number": "<string>",
      "hs_code": "<string>",
      "import_item_status_code": "<string>",
      "origin_nation_code": "<string>",
      "export_nation_code": "<string>",
      "packaging_unit_code": "<string>",
      "quantity_unit_code": "<string>",
      "gross_weight": "<double>",
      "net_weight": "<double>",
      "supplier_name": "<string>",
      "agent_name": "<string>",
      "invoice_foreign_currency_amount": "<double>",
      "invoice_foreign_currency_code": "<string>",
      "invoice_foreign_currency_exchange": "<double>",
      "workflow_state": "RETURNED",
      "sent_to_etims": "<boolean>",
      "organisation": "<uuid>",
      "branch": "<uuid>",
      "product": "<uuid>"
    }
  ]
}

json

application/json

Create etims import item

POST

https://api-dev.slade360edi.com/erp

/api/etims/etims_imports

Create and persist single or multiple records.

Create etims import item › Headers

Content-Type

string · enum · required · style: simple

Enum values:

application/json

Example: application/json

Accept

string · required · style: simple

Create etims import item › Request Body optional

item_name

string · required

package

integer · int32 · required

(Double) package number

Example: 12

quantity

integer · int32 · required

declaration_date

string · required

organisation

string · required

organization id

Example: {{organisation_id}}

branch

string · required

ranch id

Example: c685d3f7-08f6-40ec-b343-c31323a6fcd2

product

string · required

product id

Example: e20a2d21-c22e-4cf4-8466-b1e5f52fce15

Create etims import item › Responses

Created

id

string · required

item_name

string · required

package

string · required

product_code

string · required

product_name

string · required

quantity

string · required

task_code

string · required

declaration_date

string · required

item_sequence

string · required

declaration_number

string · required

hs_code

string · required

import_item_status_code

string · required

origin_nation_code

string · required

export_nation_code

string · required

packaging_unit_code

string · required

quantity_unit_code

string · required

gross_weight

string · required

net_weight

string · required

supplier_name

string · required

agent_name

string · required

invoice_foreign_currency_amount

string · required

invoice_foreign_currency_code

string · required

invoice_foreign_currency_exchange

string · required

workflow_state

string · required

sent_to_etims

string · required

organisation

string · required

branch

string · required

product

string · required

POST/api/etims/etims_imports

curl https://api-dev.slade360edi.com/erp/api/etims/etims_imports \
  --request POST \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'Content-Type: <string>' \
  --header 'Accept: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'item_name=Chairs' \
  --data-urlencode 'package=12' \
  --data-urlencode 'quantity=20' \
  --data-urlencode 'declaration_date=2024-11-13' \
  --data-urlencode 'organisation={{organisation_id}}' \
  --data-urlencode 'branch=c685d3f7-08f6-40ec-b343-c31323a6fcd2' \
  --data-urlencode 'product=e20a2d21-c22e-4cf4-8466-b1e5f52fce15'

Example Request Body

item_name=Chairs&package=12&quantity=20&declaration_date=2024-11-13&organisation=%7B%7Borganisation_id%7D%7D&branch=c685d3f7-08f6-40ec-b343-c31323a6fcd2&product=e20a2d21-c22e-4cf4-8466-b1e5f52fce15

text

Example Responses

{
  "id": "<integer>",
  "item_name": "<string>",
  "package": "<double>",
  "product_code": "<string>",
  "product_name": "<string>",
  "quantity": "<integer>",
  "task_code": "<string>",
  "declaration_date": "<string>",
  "item_sequence": "<integer>",
  "declaration_number": "<string>",
  "hs_code": "<string>",
  "import_item_status_code": "<string>",
  "origin_nation_code": "<string>",
  "export_nation_code": "<string>",
  "packaging_unit_code": "<string>",
  "quantity_unit_code": "<string>",
  "gross_weight": "<double>",
  "net_weight": "<double>",
  "supplier_name": "<string>",
  "agent_name": "<string>",
  "invoice_foreign_currency_amount": "<double>",
  "invoice_foreign_currency_code": "<string>",
  "invoice_foreign_currency_exchange": "<double>",
  "workflow_state": "DRAFT",
  "sent_to_etims": "<boolean>",
  "organisation": "<uuid>",
  "branch": "<uuid>",
  "product": "<uuid>"
}

json

application/json

Update import item

PUT

https://api-dev.slade360edi.com/erp

/api/etims/etims_imports/{id}

This endpoint updates an existing etims import.

Update import item › path Parameters

id

integer · int32 · required · style: simple

(Required) A unique integer value identifying this etims import.

Example: 135

Update import item › Headers

Accept

string · required · style: simple

Update import item › Request Body optional

item_name

string · required

package

integer · int32 · required

quantity

integer · int32 · required

declaration_date

string · required

organisation

string · required

branch

string · required

product

string · required

Update import item › Responses

200

id

string · required

item_name

string · required

package

string · required

product_code

string · required

product_name

string · required

quantity

string · required

task_code

string · required

declaration_date

string · required

item_sequence

string · required

declaration_number

string · required

hs_code

string · required

import_item_status_code

string · required

origin_nation_code

string · required

export_nation_code

string · required

packaging_unit_code

string · required

quantity_unit_code

string · required

gross_weight

string · required

net_weight

string · required

supplier_name

string · required

agent_name

string · required

invoice_foreign_currency_amount

string · required

invoice_foreign_currency_code

string · required

invoice_foreign_currency_exchange

string · required

workflow_state

string · required

sent_to_etims

string · required

organisation

string · required

branch

string · required

product

string · required

PUT/api/etims/etims_imports/{id}

curl https://api-dev.slade360edi.com/erp/api/etims/etims_imports/:id \
  --request PUT \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'Accept: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'item_name=Chair' \
  --data-urlencode 'package=12' \
  --data-urlencode 'quantity=20' \
  --data-urlencode 'declaration_date=2024-11-13' \
  --data-urlencode 'organisation={{organisation_id}}' \
  --data-urlencode 'branch=c685d3f7-08f6-40ec-b343-c31323a6fcd2' \
  --data-urlencode 'product=e20a2d21-c22e-4cf4-8466-b1e5f52fce15'

Example Request Body

item_name=Chair&package=12&quantity=20&declaration_date=2024-11-13&organisation=%7B%7Borganisation_id%7D%7D&branch=c685d3f7-08f6-40ec-b343-c31323a6fcd2&product=e20a2d21-c22e-4cf4-8466-b1e5f52fce15

text

Example Responses

{
  "id": "<integer>",
  "item_name": "<string>",
  "package": "<double>",
  "product_code": "<string>",
  "product_name": "<string>",
  "quantity": "<integer>",
  "task_code": "<string>",
  "declaration_date": "<string>",
  "item_sequence": "<integer>",
  "declaration_number": "<string>",
  "hs_code": "<string>",
  "import_item_status_code": "<string>",
  "origin_nation_code": "<string>",
  "export_nation_code": "<string>",
  "packaging_unit_code": "<string>",
  "quantity_unit_code": "<string>",
  "gross_weight": "<double>",
  "net_weight": "<double>",
  "supplier_name": "<string>",
  "agent_name": "<string>",
  "invoice_foreign_currency_amount": "<double>",
  "invoice_foreign_currency_code": "<string>",
  "invoice_foreign_currency_exchange": "<double>",
  "workflow_state": "DRAFT",
  "sent_to_etims": "<boolean>",
  "organisation": "<uuid>",
  "branch": "<uuid>",
  "product": "<uuid>"
}

json

application/json

Send import item to etims

POST

https://api-dev.slade360edi.com/erp

/api/etims/etims_imports/{id}/send_import_item_to_etims

This endpoint sends an import item to ETIMS.

Header

X-workstation: (required0 This is the workstation ID
Accept: specifies the format of response to accept. For JSON use the value application/json

Send import item to etims › path Parameters

id

integer · int32 · required · style: simple

(Required) A unique identifier for the etims import.

Example: 127

Send import item to etims › Headers

Accept

string · required · style: simple

Returns response in json format

Example: application/json

X-workstation

string · required · style: simple

[REQUIRED] Workstation ID

Example: X-Workstation

Send import item to etims › Responses

200

string

Example: "Import successfully sent to etims."

Fetch etims imports

GET

https://api-dev.slade360edi.com/erp

/api/etims/etims_imports/fetch_etims_imports

Fetch etims imports.

Fetch etims imports › Headers

Accept

string · required · style: simple

Returns response in json format

Example: application/json

X-Workstation

string · required · style: simple

[REQUIRED] Worstation ID

Example: X-Workstation

Fetch etims imports › Responses

200

string

Example: "Data Synced Successfully"

Stock Notices

Get etims imports list

GET

https://api-dev.slade360edi.com/erp

/api/etims/etims_imports

Etims Import Viewset.

Get etims imports list › Headers

Accept

string · required · style: simple

Get etims imports list › Responses

200

count

string · required

next

string · required

previous

string · required

Result6[] · required

Create etims import item

POST

https://api-dev.slade360edi.com/erp

/api/etims/etims_imports

Create and persist single or multiple records.

Create etims import item › Headers

Content-Type

string · enum · required · style: simple

Enum values:

application/json

Example: application/json

Accept

string · required · style: simple

Create etims import item › Request Body optional

item_name

string · required

package

integer · int32 · required

(Double) package number

Example: 12

quantity

integer · int32 · required

declaration_date

string · required

organisation

string · required

organization id

Example: {{organisation_id}}

branch

string · required

ranch id

Example: c685d3f7-08f6-40ec-b343-c31323a6fcd2

product

string · required

product id

Example: e20a2d21-c22e-4cf4-8466-b1e5f52fce15

Create etims import item › Responses

Created

id

string · required

item_name

string · required

package

string · required

product_code

string · required

product_name

string · required

quantity

string · required

task_code

string · required

declaration_date

string · required

item_sequence

string · required

declaration_number

string · required

hs_code

string · required

import_item_status_code

string · required

origin_nation_code

string · required

export_nation_code

string · required

packaging_unit_code

string · required

quantity_unit_code

string · required

gross_weight

string · required

net_weight

string · required

supplier_name

string · required

agent_name

string · required

invoice_foreign_currency_amount

string · required

invoice_foreign_currency_code

string · required

invoice_foreign_currency_exchange

string · required

workflow_state

string · required

sent_to_etims

string · required

organisation

string · required

branch

string · required

product

string · required

Update import item

PUT

https://api-dev.slade360edi.com/erp

/api/etims/etims_imports/{id}

This endpoint updates an existing etims import.

Update import item › path Parameters

id

integer · int32 · required · style: simple

(Required) A unique integer value identifying this etims import.

Example: 135

Update import item › Headers

Accept

string · required · style: simple

Update import item › Request Body optional

item_name

string · required

package

integer · int32 · required

quantity

integer · int32 · required

declaration_date

string · required

organisation

string · required

branch

string · required

product

string · required

Update import item › Responses

200

id

string · required

item_name

string · required

package

string · required

product_code

string · required

product_name

string · required

quantity

string · required

task_code

string · required

declaration_date

string · required

item_sequence

string · required

declaration_number

string · required

hs_code

string · required

import_item_status_code

string · required

origin_nation_code

string · required

export_nation_code

string · required

packaging_unit_code

string · required

quantity_unit_code

string · required

gross_weight

string · required

net_weight

string · required

supplier_name

string · required

agent_name

string · required

invoice_foreign_currency_amount

string · required

invoice_foreign_currency_code

string · required

invoice_foreign_currency_exchange

string · required

workflow_state

string · required

sent_to_etims

string · required

organisation

string · required

branch

string · required

product

string · required

Send import item to etims

POST

https://api-dev.slade360edi.com/erp

/api/etims/etims_imports/{id}/send_import_item_to_etims

This endpoint sends an import item to ETIMS.

Header

X-workstation: (required0 This is the workstation ID
Accept: specifies the format of response to accept. For JSON use the value application/json

Send import item to etims › path Parameters

id

integer · int32 · required · style: simple

(Required) A unique identifier for the etims import.

Example: 127

Send import item to etims › Headers

Accept

string · required · style: simple

Returns response in json format

Example: application/json

X-workstation

string · required · style: simple

[REQUIRED] Workstation ID

Example: X-Workstation

Send import item to etims › Responses

200

string

Example: "Import successfully sent to etims."

Fetch etims imports

GET

https://api-dev.slade360edi.com/erp

/api/etims/etims_imports/fetch_etims_imports

Fetch etims imports.

Fetch etims imports › Headers

Accept

string · required · style: simple

Returns response in json format

Example: application/json

X-Workstation

string · required · style: simple

[REQUIRED] Worstation ID

Example: X-Workstation

Fetch etims imports › Responses

200

string

Example: "Data Synced Successfully"