Versions Compared

Old Version 2

changes.mady.by.user Thomas.Bunge (Unlicensed)

Saved on

compared with

New Version 3

changes.mady.by.user Javier.Marroquin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

POST Request Example (application/json)

Name

Data Type

Description

Required

BillToCode

string

Organization or branch code for Bill-to

YES

BranchCode

string

Organization or branch code for Branch

YES

ConsolidatorCode

string

Organization or branch code for Consolidator

YES

DestinationCode

string

Organization or branch code for Destination

YES

MawbNumber

string (format: 123-12345678)

YES

OriginCode

string

Organization or branch code for Shipper

YES

ShipperCode

string

Organization or branch code for Shipper

YES

OriginPort

string (ex. ORD)

3-letter IATA airport code for origin

YES

DestinationPort

string (ex. JFK)

3-letter IATA airport code for destination

YES

ClientNotes

string (max 200)

NO

Flights[].Eta

string (ISO Date)

ETA (local time)

YES

Flights[].Etd

string (ISO Date)

ETD (local time)

YES

Flights[].Number

string (ex. UA123)

2-letter IATA airline code and flight number

Manifests[].Data

string (Base 64 encoded data)

Data must be a .csv file or .xlsx file used for uploading to AC NOVA website

YES

Code Block
languagejson
{
  "BillToCode": "CHI",
  "BranchCode": "JFK",
  "ClientNotes": "just testing...",
  "ConsolidatorCode": "JFK",
  "DestinationCode": "JFK",
  "DestinationPort": "ORD",
  "Flights": [
    {
      "Eta": "2022-01-15T13:30",
      "Etd": "2022-01-16T03:30",
      "Number": "NH12"
    }
  ],
  "Manifests": [
    {
      "Data": "Y29uc2lnbm9yX2l0ZW1faWQscmVjZXB0YWNsZV9pZCxzZW5kZXJfbmFtZSxzZW5kZXJfb3JnbmFtZSxzZW5kZXJfYWRkcmVzczEsc2VuZGVyX2FkZHJlc3MyLHNlbmRlcl9kaXN0cmljdCxzZW5kZXJfY2l0eSxzZW5kZXJfc3RhdGUsc2VuZGVyX3ppcDUsc2VuZGVyX3ppcDQsc2VuZGVyX2NvdW50cnksc2VuZGVyX3Bob25lLHNlbmRlcl9lbWFpbCxyZWNpcGllbnRfbmFtZSxyZWNpcGllbnRfb3JnbmFtZSxyZWNpcGllbnRfYWRkcmVzczEscmVjaXBpZW50X2FkZHJlc3MyLHJlY2lwaWVudF9kaXN0cmljdCxyZWNpcGllbnRfY2l0eSxyZWNpcGllbnRfc3RhdGUscmVjaXBpZW50X3ppcDUscmVjaXBpZW50X3ppcDQscmVjaXBpZW50X2NvdW50cnkscmVjaXBpZW50X3Bob25lLHJlY2lwaWVudF9lbWFpbCxyZWNpcGllbnRfYWRkcl90eXBlLEZpbmFsX01pbGVfQ291cmllcixGaW5hbCBNaWxlIFBheW1lbnQgKFNFS08gb3IgT3duKSxsZW5ndGgsd2lkdGgsaGVpZ2h0LGdpcnRoLGRlc2NyaXB0aW9uLHVybCxjb3VudHJ5X29mX29yaWdpbixtYW51ZmFjdHVyZXIsSGFybW9uaXphdGlvbl9jb2RlLHVuaXRfdmFsdWUscXVhbnRpdHksdG90YWxfdmFsdWUsdG90YWxfd2VpZ2h0DQowMTExMjE1OTA4ZGE4YzM2MTg1YjAsOTkwMTExMjE1OTAwMCxLYWxpIExFSSwsMCBqaW5nc2FuIFdhbGtzUm9hZCwsLHNoZW56aGVuLGd1YW5nZG9uZyx1dDcgMW5jLCxDTiwxOTEtMTU2LTgxNjksLERyLiBSb3dlbmEgRmxhdGxleSwsNTYzNyBBc3N1bnRhIFdhbGtzIEFwdCAwLCwsS3JhamNpa2xhbmQsU0MsODI3MDEsLFVTLDExMS01NTQtNDEzMiwsLEZFRFgsT1dOLDYsMyw4LDMxLExUZXN0LCxDTiwsNjQwNTkwMjAwMCwzMSwxLDMxLDAuNDE0DQo="
    }
  ],
  "MawbNumber": "205-89548112",
  "OriginPort": "NRT",
  "ShipperCode": "JFK",
  "OriginCode": "CHI"
}

...

Code Block
HTTP/1.1 422 Unprocessable Entity

{
  "errors": {
    "": [
      "Row 1: \u0027VB\u0027 is not a valid country code for Shipper Country."
    ]
  },
  "status": 422,
  "title": "One or more errors occurred.",
}

...

Manifest

The user can add a manifest to an existing MAWB using the created MawbNumber as the mawbKey

Code Block
languagenone
POST /api/mawbs/{mawbKey}/manifests

Example

Code Block
/api/mawbs/205-89548112/manifests

POST Request Example (application/json)

Name

Data Type

Description

Required

Data

string (Base 64 encoded data)

Data must be a .csv file or .xlsx file used for uploading to AC NOVA website

YES

Code Block
languagejson
{
  "Data": "Y29uc2lnbm9yX2l0ZW1faWQscmVjZXB0YWNsZV9pZCxzZW5kZXJfbmFtZSxzZW5kZXJfb3JnbmFtZSxzZW5kZXJfYWRkcmVzczEsc2VuZGVyX2FkZHJlc3MyLHNlbmRlcl9kaXN0cmljdCxzZW5kZXJfY2l0eSxzZW5kZXJfc3RhdGUsc2VuZGVyX3ppcDUsc2VuZGVyX3ppcDQsc2VuZGVyX2NvdW50cnksc2VuZGVyX3Bob25lLHNlbmRlcl9lbWFpbCxyZWNpcGllbnRfbmFtZSxyZWNpcGllbnRfb3JnbmFtZSxyZWNpcGllbnRfYWRkcmVzczEscmVjaXBpZW50X2FkZHJlc3MyLHJlY2lwaWVudF9kaXN0cmljdCxyZWNpcGllbnRfY2l0eSxyZWNpcGllbnRfc3RhdGUscmVjaXBpZW50X3ppcDUscmVjaXBpZW50X3ppcDQscmVjaXBpZW50X2NvdW50cnkscmVjaXBpZW50X3Bob25lLHJlY2lwaWVudF9lbWFpbCxyZWNpcGllbnRfYWRkcl90eXBlLEZpbmFsX01pbGVfQ291cmllcixGaW5hbCBNaWxlIFBheW1lbnQgKFNFS08gb3IgT3duKSxsZW5ndGgsd2lkdGgsaGVpZ2h0LGdpcnRoLGRlc2NyaXB0aW9uLHVybCxjb3VudHJ5X29mX29yaWdpbixtYW51ZmFjdHVyZXIsSGFybW9uaXphdGlvbl9jb2RlLHVuaXRfdmFsdWUscXVhbnRpdHksdG90YWxfdmFsdWUsdG90YWxfd2VpZ2h0DQowMTExMjE1OTA4ZGE4YzM2MTg1YjAsOTkwMTExMjE1OTAwMCxLYWxpIExFSSwsMCBqaW5nc2FuIFdhbGtzUm9hZCwsLHNoZW56aGVuLGd1YW5nZG9uZyx1dDcgMW5jLCxDTiwxOTEtMTU2LTgxNjksLERyLiBSb3dlbmEgRmxhdGxleSwsNTYzNyBBc3N1bnRhIFdhbGtzIEFwdCAwLCwsS3JhamNpa2xhbmQsU0MsODI3MDEsLFVTLDExMS01NTQtNDEzMiwsLEZFRFgsT1dOLDYsMyw4LDMxLExUZXN0LCxDTiwsNjQwNTkwMjAwMCwzMSwxLDMxLDAuNDE0DQo="
}

POST Response Example (application/json)

Code Block
languagejson
HTTP/1.1 201 Created
Content-Type: application/json

[
    {
        "manifestId": "66df256f-4e5e-ee11-9937-000d3a60f54d",
        "status": "Processed",
        "mawbId": "faf3c6d0-132a-ed11-ae83-281878191b28",
        "number": "001",
        "carrierCode": "NH",
        "carrierPayment": "OWN",
        "carrierAccountCode": "7890",
        "serviceLevel": null,
        "hawbCount": 10,
        "masterCartonCount": 10,
        "totalWeight": 4.10,
        "weightUnit": "KG",
        "totalValue": 605.00,
        "currencyUnit": "USD",
        "fileId": "ecde3aa9-6aa6-4be6-87c4-68decc109cf1",
        "estimatedOriginPickup": null,
        "created": "2022-09-01T16:33:32Z",
        "createdBy": "USER_NAME"
    }
]
Code Block
HTTP/1.1 422 Unprocessable Entity

{
  "errors": {
    "": [
      "Row 1: MAWB does not exist."
    ]
  },
  "status": 422,
  "title": "One or more errors occurred.",
}