Ground End of Day Close API

Introdução

A API de Fecho ao Fim do Dia Ground^® permite-lhe consolidar informações de expedição na conta FedEx Ground e imprimir um manifesto Ground para o seu motorista. O Manifesto Ground é gerado após um fecho bem-sucedido e tem de ser impresso antes de as expedições Ground serem apresentadas à FedEx. Um cliente pode continuar a expedir volumes Ground mesmo depois de ter sido efetuado o fecho.

Detalhes da API de Fecho ao Fim do Dia Ground

Esta API permite-lhe carregar dados de volumes para a FedEx, gerar relatórios de manifesto e fechar a expedição FedEx Ground^® correspondente (nacional e internacional dos EUA).

Funcionalidades da API de Fecho ao Fim do Dia Ground:

Todas as expedições com o mesmo campo de referência podem ser agrupadas e fechadas como um conjunto.
A funcionalidade de confirmação de referência identifica o subconjunto de expedições para imprimir os relatórios configurados.
O Fecho ao Fim do Dia com designação de referência da funcionalidade de fecho efetua a operação de fecho das expedições. Estas expedições estão associadas ao campo de referência especificado.
Esta API carrega informações de expedições Ground na conta FedEx.
A funcionalidade Erro de Verificação de Expedição Aberta designa o nível de processamento de erros devolvidos numa resposta. Pode utilizá-la para analisar Expedições Abertas não confirmadas através de uma transação de Fecho ao Fim do Dia.

Como Funciona a API de Fecho ao Fim do Dia Ground

Seguem-se algumas das operações na API de Fecho ao Fim do Dia FedEx Ground:

Pedido de Fecho ao Fim do Dia Ground

Inicia a fase final do processamento de todos os dados de expedições enviados pelo cliente no dia (fecho de negócio) para expedições FedEx Ground. A resposta só devolve o Manifesto Ground. O Manifesto Ground só está disponível num formato de texto (.txt).

Seguem-se as informações introduzidas relevantes associadas a este pedido:

Data de Fecho
Especificações de Relatórios/Documentos de Expedição
Número de Conta FedEx
Categoria FedEx Ground (FedEx Ground)

A resposta bem-sucedida irá fechar as expedições e gerar os documentos/relatórios especificados.

Pedido Imprimir Novamente os Documentos

Gera os relatórios especificados pelo utilizador criados quando a operação de fecho for processada. Devolve todos os relatórios especificados gerados para um dia específico. Só pode imprimir novamente os relatórios até três dias no passado.

Seguem-se as informações introduzidas relevantes associadas a este pedido:

Data de Fecho
Opção Imprimir Novamente
Especificações de Relatórios/Documentos de Expedição
Número de Conta FedEx
Categoria FedEx Ground (FedEx Ground)

A resposta bem-sucedida irá imprimir novamente os relatórios/documentos.

Fecho Ground

A Operação de Fecho pode ser efetuada várias vezes a cada dia de expedição. Não existe necessidade de reabrir após o processamento de um fecho. Basta começar a expedir novamente. Utilize o Serviço de Fecho para iniciar a fase final de processamento de todos os dados de expedições enviados para o dia (fecho de negócio).

Para obter informações detalhadas sobre os serviços oferecidos pela FedEx, consulte o Guia de Serviços FedEx eletrónico.

Relatórios FedEx Ground

Manifesto Ground

Após a conclusão de uma atividade de etiquetas de expedição FedEx Ground no dia a decorrer, o cliente tem de \"fechar\" as etiquetas FedEx Ground pendentes e imprimir um Manifesto FedEx Ground e entregar este manifesto ao motorista ou funcionário FedEx. Este manifesto indica toda a atividade de impressão do FedEx Ground e é exigido pela FedEx para processamento.

O relatório do Manifesto FedEx Ground pode ser impresso ou impresso novamente a qualquer momento imediatamente após o Fecho ao Fim do Dia ou numa data posterior, se houver mais do que um fecho do dia. O relatório do Manifesto FedEx Ground irá incluir todas as expedições FedEx Ground geradas nas últimas 24 horas.

O Manifesto de Recolha FedEx Ground para Serviços Consolidados da FedEx é idêntico ao relatório padrão gerado para qualquer tipo de expedições de volumes do FedEx Ground. O Manifesto de Recolha FedEx Ground é exigido pelo estafeta do FedEx Ground para expedir volumes. Disponibiliza um resumo dos volumes recolhidos num determinado dia ao estafeta do FedEx Ground e as seguintes informações:

Número de conta do remetente
Número de contador do remetente
Número de rastreio de todos os volumes
Valor do COD (se aplicável)
Valor declarado (se aplicável)
Número de volumes de Dimensões Excessivas I
Número de volumes de Dimensões Excessivas II
Número de volumes que requerem processamento adicional
Número de volumes para entrega residencial
Número total de volumes
Número de confirmação de recolha

Regras Empresariais

A operação de Fecho é opcional, mas é recomendada. Pode ser necessária se precisar de alguns dos relatórios gerados.
As expedições FedEx Ground podem ser eliminadas após um Fecho.
O endereço no cabeçalho do manifesto é extraído do primeiro volume expedido no dia especificado.

Recolha da API JSON

Ship EndofDayClose API (1.0.0)

Ground End Of Day Close

Use this endpoint to close the Ground shipments and generate the reports.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema_GEOD_PUT
MinimumSamplePayload-Put-GroundClose

closeReqType	string Enum: "GCDR" "RGCDR" Specify the close request type to initiate processing of shipment data.For ground close the closeReqType is GCDR and for Reprint EndofDay the applicable value is RGCDR.
accountNumber	object (AccountNumber_2) This is the FedEx Account number. Example: XXX456XXX
groundServiceCategory	string Value: "GROUND" This is to specify FedEx ground category for which the shipment to be submitted for end of the day closing.
closeDate	string Indicates the close date. Example: 2020-05-05
trackingNumber	string Specify the tracking number for reprinting the report.It is only applicable for reprint EndofDay and its not applicable for ground EndofDay close endpoint. Example: 7XX96XX42946
reprintOption	string Enum: "BY_SHIP_DATE" "BY_TRACKING_NUMBER" Specify the reprint option to generate report. Either by close date or a tracking number.It is only applicable for reprint EndofDay and its not applicable for ground EndofDay close endpoint.
closeDocumentSpecification	object (CloseDocumentSpecification) Specifies characteristics of the document to be returned for this request.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/endofday/

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/endofday/

Production Server

https://apis.fedex.com/ship/v1/endofday/

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"closeReqType": "GCDR",
"accountNumber":
{
- "value": "123456789"
},
"groundServiceCategory": "GROUND",
"closeDate": "2020-05-05",
"trackingNumber": "794967542946",
"reprintOption": "BY_SHIP_DATE",
"closeDocumentSpecification":
{
- "closeDocumentTypes":
  [
  - "OP_950"
  ],
- "op950Detail":
  {
  - "format":
    {
    "topOfPageOffset":
    {
    "value": "0",
    "units": "CM"
    },
    "imageType": "PDF",
    "stockType": "OP_950",
    "locale": "en_US"
    }
  }
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"output":
{
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ],
- "closeDocuments":
  [
  - {
    "type": "OP_950",
    "shippingCycle": "1003234523333204",
    "shippingDocumentDisposition": "CONFIRMED",
    "accessReference": null,
    "resolution": 200,
    "copiesToPrint": 1,
    "parts":
    [
    {
    "documentPartSequenceNumber": 1,
    "image": "ICAgICAg.."
    }
    ]
    }
  ]
}

}

Reprint End of the day

Use this endpoint to reprint the closed Ground shipments reports.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema_Reprint_POST
MinimumSamplePayload-Post-Reprintground

closeReqType	string Enum: "GCDR" "RGCDR" Specify the close request type to initiate processing of shipment data.For ground close the closeReqType is GCDR and for Reprint EndofDay the applicable value is RGCDR.
accountNumber	object (AccountNumber_2) This is the FedEx Account number. Example: XXX456XXX
groundServiceCategory	string Value: "GROUND" This is to specify FedEx ground category for which the shipment to be submitted for end of the day closing.
closeDate	string Indicates the close date. Example: 2020-05-05
trackingNumber	string Specify the tracking number for reprinting the report.It is only applicable for reprint EndofDay and its not applicable for ground EndofDay close endpoint. Example: 7XX96XX42946
reprintOption	string Enum: "BY_SHIP_DATE" "BY_TRACKING_NUMBER" Specify the reprint option to generate report. Either by close date or a tracking number.It is only applicable for reprint EndofDay and its not applicable for ground EndofDay close endpoint.
closeDocumentSpecification	object (CloseDocumentSpecification) Specifies characteristics of the document to be returned for this request.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/endofday/

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/endofday/

Production Server

https://apis.fedex.com/ship/v1/endofday/

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all

{

"closeReqType": "GCDR",
"accountNumber":
{
- "value": "123456789"
},
"groundServiceCategory": "GROUND",
"closeDate": "2020-05-05",
"trackingNumber": "794967542946",
"reprintOption": "BY_SHIP_DATE",
"closeDocumentSpecification":
{
- "closeDocumentTypes":
  [
  - "OP_950"
  ],
- "op950Detail":
  {
  - "format":
    {
    "topOfPageOffset":
    {
    "value": "0",
    "units": "CM"
    },
    "imageType": "PDF",
    "stockType": "OP_950",
    "locale": "en_US"
    }
  }
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"output":
{
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ],
- "closeDocuments":
  [
  - {
    "type": "OP_950",
    "shippingCycle": "1003234523333204",
    "shippingDocumentDisposition": "CONFIRMED",
    "accessReference": null,
    "resolution": 200,
    "copiesToPrint": 1,
    "parts":
    [
    {
    "documentPartSequenceNumber": 1,
    "image": "ICAgICAg.."
    }
    ]
    }
  ]
}

}

Request
Response

Response

Copy

Developer Portal

Ground End of Day Close API

Introdução

Detalhes da API de Fecho ao Fim do Dia Ground

Como Funciona a API de Fecho ao Fim do Dia Ground

Fecho Ground

Relatórios FedEx Ground

Regras Empresariais

Recolha da API JSON

Ship EndofDayClose API (1.0.0)

Ground End Of Day Close

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Reprint End of the day

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Enter your user ID and password to log in